Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / displayvideo_v1.partners.channels.sites.html
blob: db59f19fba9e82f76a01feef91787f76aaad5acd [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.partners.html">partners</a> . <a href="displayvideo_v1.partners.channels.html">channels</a> . <a href="displayvideo_v1.partners.channels.sites.html">sites</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#bulkEdit">bulkEdit(partnerId, channelId, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.</p>
80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#create">create(partnerId, channelId, body=None, advertiserId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Creates a site in a channel.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Deletes a site from a channel.</p>
89<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]90 <code><a href="#list">list(partnerId, channelId, pageSize=None, advertiserId=None, pageToken=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91<p class="firstline">Lists sites in a channel.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="bulkEdit">bulkEdit(partnerId, channelId, body=None, x__xgafv=None)</code>
98 <pre>Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
99
100Args:
101 partnerId: string, The ID of the partner that owns the parent channel. (required)
102 channelId: string, Required. The ID of the parent channel to which the sites belong. (required)
103 body: object, The request body.
104 The object takes the form of:
105
106{ # Request message for SiteService.BulkEditSites.
107 &quot;deletedSites&quot;: [ # The sites to delete in batch, specified as a list of site url_or_app_ids.
108 &quot;A String&quot;,
109 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]110 &quot;createdSites&quot;: [ # The sites to create in batch, specified as a list of Sites.
111 { # A single site. Sites are apps or websites belonging to a channel.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]112 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the site.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]113 &quot;urlOrAppId&quot;: &quot;A String&quot;, # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]114 },
115 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]116 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the parent channel.
117 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the parent channel.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]118 }
119
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125Returns:
126 An object of the form:
127
128 { # Response message for SiteService.BulkEditSites.
129 &quot;sites&quot;: [ # The list of sites that have been successfully created. This list will be absent if empty.
130 { # A single site. Sites are apps or websites belonging to a channel.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]131 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the site.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]132 &quot;urlOrAppId&quot;: &quot;A String&quot;, # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]133 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 ],
135 }</pre>
136</div>
137
138<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 <code class="details" id="close">close()</code>
140 <pre>Close httplib2 connections.</pre>
141</div>
142
143<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]144 <code class="details" id="create">create(partnerId, channelId, body=None, advertiserId=None, x__xgafv=None)</code>
145 <pre>Creates a site in a channel.
146
147Args:
148 partnerId: string, The ID of the partner that owns the parent channel. (required)
149 channelId: string, Required. The ID of the parent channel in which the site will be created. (required)
150 body: object, The request body.
151 The object takes the form of:
152
153{ # A single site. Sites are apps or websites belonging to a channel.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]154 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the site.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]155 &quot;urlOrAppId&quot;: &quot;A String&quot;, # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]157
158 advertiserId: string, The ID of the advertiser that owns the parent channel.
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # A single site. Sites are apps or websites belonging to a channel.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]168 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the site.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]169 &quot;urlOrAppId&quot;: &quot;A String&quot;, # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]170 }</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171</div>
172
173<div class="method">
174 <code class="details" id="delete">delete(partnerId, channelId, urlOrAppId, advertiserId=None, x__xgafv=None)</code>
175 <pre>Deletes a site from a channel.
176
177Args:
178 partnerId: string, The ID of the partner that owns the parent channel. (required)
179 channelId: string, Required. The ID of the parent channel to which the site belongs. (required)
180 urlOrAppId: string, Required. The URL or app ID of the site to delete. (required)
181 advertiserId: string, The ID of the advertiser that owns the parent channel.
182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186
187Returns:
188 An object of the form:
189
190 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
191 }</pre>
192</div>
193
194<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]195 <code class="details" id="list">list(partnerId, channelId, pageSize=None, advertiserId=None, pageToken=None, filter=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]196 <pre>Lists sites in a channel.
197
198Args:
199 partnerId: string, The ID of the partner that owns the parent channel. (required)
200 channelId: string, Required. The ID of the parent channel to which the requested sites belong. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]201 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]202 advertiserId: string, The ID of the advertiser that owns the parent channel.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]203 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
204 filter: string, Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL or app ID contains &quot;google&quot;: `urlOrAppId : &quot;google&quot;`
205 orderBy: string, Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix &quot; desc&quot; should be added to the field name. Example: `urlOrAppId desc`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211Returns:
212 An object of the form:
213
214 { # Response message for SiteService.ListSites.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]215 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 &quot;sites&quot;: [ # The list of sites. This list will be absent if empty.
217 { # A single site. Sites are apps or websites belonging to a channel.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]218 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the site.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]219 &quot;urlOrAppId&quot;: &quot;A String&quot;, # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]220 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]221 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
227 <pre>Retrieves the next page of results.
228
229Args:
230 previous_request: The request for the previous page. (required)
231 previous_response: The response from the request for the previous page. (required)
232
233Returns:
234 A request object that you can call &#x27;execute()&#x27; on to request the next
235 page. Returns None if there are no more items in the collection.
236 </pre>
237</div>
238
239</body></html>