Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cdf480e8145d58600a5224efc68ba2ace973ef62 / . / docs / dyn / displayvideo_v1.inventorySourceGroups.html
blob: d5a4490a1ff09239f02a60699368164a777dc0f1 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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.inventorySourceGroups.html">inventorySourceGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="displayvideo_v1.inventorySourceGroups.assignedInventorySources.html">assignedInventorySources()</a></code>
79</p>
80<p class="firstline">Returns the assignedInventorySources Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]86 <code><a href="#create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87<p class="firstline">Creates a new inventory source group. Returns the newly created inventory source group if successful.</p>
88<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]89 <code><a href="#delete">delete(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90<p class="firstline">Deletes an inventory source group.</p>
91<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]92 <code><a href="#get">get(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93<p class="firstline">Gets an inventory source group.</p>
94<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]95 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96<p class="firstline">Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]100<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]101 <code><a href="#patch">patch(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102<p class="firstline">Updates an inventory source group. Returns the updated inventory source group if successful.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103<h3>Method Details</h3>
104<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105 <code class="details" id="close">close()</code>
106 <pre>Close httplib2 connections.</pre>
107</div>
108
109<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]110 <code class="details" id="create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 <pre>Creates a new inventory source group. Returns the newly created inventory source group if successful.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112
113Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 body: object, The request body.
115 The object takes the form of:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]116
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117{ # A collection of targetable inventory sources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]118 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]119 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source group. Assigned by the system.
120 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source group.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]121}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]123 advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]124 partnerId: string, The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
133 { # A collection of targetable inventory sources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]134 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
135 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source group. Assigned by the system.
136 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source group.
137}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138</div>
139
140<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]141 <code class="details" id="delete">delete(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 <pre>Deletes an inventory source group.
143
144Args:
145 inventorySourceGroupId: string, Required. The ID of the inventory source group to delete. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]146 advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]147 partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153Returns:
154 An object of the form:
155
156 { # 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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]157}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158</div>
159
160<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]161 <code class="details" id="get">get(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 <pre>Gets an inventory source group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163
164Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]165 inventorySourceGroupId: string, Required. The ID of the inventory source group to fetch. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]166 advertiserId: string, The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]167 partnerId: string, The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]173Returns:
174 An object of the form:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]176 { # A collection of targetable inventory sources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]177 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
178 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source group. Assigned by the system.
179 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source group.
180}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]181</div>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]183<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]184 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]185 <pre>Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]187Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]188 advertiserId: string, The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]189 filter: string, Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]190 orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` 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. For example, `displayName desc`.
191 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]192 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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]193 partnerId: string, The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
202 { # Response message for InventorySourceGroupService.ListInventorySourceGroups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]203 &quot;inventorySourceGroups&quot;: [ # The list of inventory source groups. This list will be absent if empty.
204 { # A collection of targetable inventory sources.
205 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
206 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source group. Assigned by the system.
207 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source group.
208 },
209 ],
210 &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 `ListInventorySourceGroups` method to retrieve the next page of results.
211}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]212</div>
213
214<div class="method">
215 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
216 <pre>Retrieves the next page of results.
217
218Args:
219 previous_request: The request for the previous page. (required)
220 previous_response: The response from the request for the previous page. (required)
221
222Returns:
223 A request object that you can call &#x27;execute()&#x27; on to request the next
224 page. Returns None if there are no more items in the collection.
225 </pre>
226</div>
227
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]229 <code class="details" id="patch">patch(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]230 <pre>Updates an inventory source group. Returns the updated inventory source group if successful.
231
232Args:
233 inventorySourceGroupId: string, Output only. The unique ID of the inventory source group. Assigned by the system. (required)
234 body: object, The request body.
235 The object takes the form of:
236
237{ # A collection of targetable inventory sources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]238 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]239 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source group. Assigned by the system.
240 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source group.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]241}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]242
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]243 advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]244 partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 updateMask: string, Required. The mask to control which fields to update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251Returns:
252 An object of the form:
253
254 { # A collection of targetable inventory sources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]255 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
256 &quot;inventorySourceGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source group. Assigned by the system.
257 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source group.
258}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]259</div>
260
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261</body></html>