Debian Codegraph @

docs/dyn/displayvideo_v3.inventorySourceGroups.assignedInventorySources.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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_v3.html">Display & Video 360 API</a> . <a href="displayvideo_v3.inventorySourceGroups.html">inventorySourceGroups</a> . <a href="displayvideo_v3.inventorySourceGroups.assignedInventorySources.html">assignedInventorySources</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#bulkEdit">bulkEdit(inventorySourceGroupId, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#create">create(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Creates an assignment between an inventory source and an inventory source group.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(inventorySourceGroupId, assignedInventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the assignment between an inventory source and an inventory source group.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(inventorySourceGroupId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists inventory sources assigned to an inventory source group.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</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(inventorySourceGroupId, body=None, x__xgafv=None)</code>
98 <pre>Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
99
100 Args:
101 inventorySourceGroupId: string, Required. The ID of the inventory source group to which the assignments are assigned. (required)
102 body: object, The request body.
103 The object takes the form of:
104
105 { # Request message for AssignedInventorySourceService.BulkEdit.
106 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.
107 &quot;createdAssignedInventorySources&quot;: [ # The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources.
108 { # An assignment between a targetable inventory source and an inventory source group.
109 &quot;assignedInventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
110 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. The ID of the inventory source entity being targeted.
111 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned inventory source.
112 },
113 ],
114 &quot;deletedAssignedInventorySources&quot;: [ # The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids.
115 &quot;A String&quot;,
116 ],
117 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources.
118 }
119
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125 Returns:
126 An object of the form:
127
128 { # Response message for AssignedInventorySourceService.BulkEdit.
129 &quot;assignedInventorySources&quot;: [ # The list of assigned inventory sources that have been successfully created. This list will be absent if empty.
130 { # An assignment between a targetable inventory source and an inventory source group.
131 &quot;assignedInventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
132 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. The ID of the inventory source entity being targeted.
133 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned inventory source.
134 },
135 ],
136 }</pre>
137 </div>
138
139 <div class="method">
140 <code class="details" id="close">close()</code>
141 <pre>Close httplib2 connections.</pre>
142 </div>
143
144 <div class="method">
145 <code class="details" id="create">create(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
146 <pre>Creates an assignment between an inventory source and an inventory source group.
147
148 Args:
149 inventorySourceGroupId: string, Required. The ID of the inventory source group to which the assignment will be assigned. (required)
150 body: object, The request body.
151 The object takes the form of:
152
153 { # An assignment between a targetable inventory source and an inventory source group.
154 &quot;assignedInventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
155 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. The ID of the inventory source entity being targeted.
156 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned inventory source.
157 }
158
159 advertiserId: string, The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
160 partnerId: string, The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.
161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166 Returns:
167 An object of the form:
168
169 { # An assignment between a targetable inventory source and an inventory source group.
170 &quot;assignedInventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
171 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. The ID of the inventory source entity being targeted.
172 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned inventory source.
173 }</pre>
174 </div>
175
176 <div class="method">
177 <code class="details" id="delete">delete(inventorySourceGroupId, assignedInventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
178 <pre>Deletes the assignment between an inventory source and an inventory source group.
179
180 Args:
181 inventorySourceGroupId: string, Required. The ID of the inventory source group to which this assignment is assigned. (required)
182 assignedInventorySourceId: string, Required. The ID of the assigned inventory source to delete. (required)
183 advertiserId: string, The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
184 partnerId: string, The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190 Returns:
191 An object of the form:
192
193 { # 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); }
194 }</pre>
195 </div>
196
197 <div class="method">
198 <code class="details" id="list">list(inventorySourceGroupId, advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
199 <pre>Lists inventory sources assigned to an inventory source group.
200
201 Args:
202 inventorySourceGroupId: string, Required. The ID of the inventory source group to which these assignments are assigned. (required)
203 advertiserId: string, The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.
204 filter: string, Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
205 orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (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: `assignedInventorySourceId desc`.
206 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.
207 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 `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
208 partnerId: string, The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214 Returns:
215 An object of the form:
216
217 { # Response message for AssignedInventorySourceService.ListAssignedInventorySources.
218 &quot;assignedInventorySources&quot;: [ # The list of assigned inventory sources. This list will be absent if empty.
219 { # An assignment between a targetable inventory source and an inventory source group.
220 &quot;assignedInventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.
221 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Required. The ID of the inventory source entity being targeted.
222 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned inventory source.
223 },
224 ],
225 &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 `ListAssignedInventorySources` method to retrieve the next page of results.
226 }</pre>
227 </div>
228
229 <div class="method">
230 <code class="details" id="list_next">list_next()</code>
231 <pre>Retrieves the next page of results.
232
233 Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237 Returns:
238 A request object that you can call &#x27;execute()&#x27; on to request the next
239 page. Returns None if there are no more items in the collection.
240 </pre>
241 </div>
242
243 </body></html>