1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="displayvideo_v2.html">Display & Video 360 API</a> . <a href="displayvideo_v2.inventorySourceGroups.html">inventorySourceGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="displayvideo_v2.inventorySourceGroups.assignedInventorySources.html">assignedInventorySources()</a></code>
</p>
<p class="firstline">Returns the assignedInventorySources Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new inventory source group. Returns the newly created inventory source group if successful.</p>
<p class="toc_element">
<code><a href="#delete">delete(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an inventory source group.</p>
<p class="toc_element">
<code><a href="#get">get(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an inventory source group.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an inventory source group. Returns the updated inventory source group if successful.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
<pre>Creates a new inventory source group. Returns the newly created inventory source group if successful.
Args:
body: object, The request body.
The object takes the form of:
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
}
advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
<pre>Deletes an inventory source group.
Args:
inventorySourceGroupId: string, Required. The ID of the inventory source group to delete. (required)
advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(inventorySourceGroupId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
<pre>Gets an inventory source group.
Args:
inventorySourceGroupId: string, Required. The ID of the inventory source group to fetch. (required)
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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
<pre>Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
Args:
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.
filter: string, Allows filtering by inventory source group fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` 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.
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 "desc" should be added to the field name. For example, `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
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.
partnerId: string, The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for InventorySourceGroupService.ListInventorySourceGroups.
"inventorySourceGroups": [ # The list of inventory source groups. This list will be absent if empty.
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
},
],
"nextPageToken": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(inventorySourceGroupId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an inventory source group. Returns the updated inventory source group if successful.
Args:
inventorySourceGroupId: string, Output only. The unique ID of the inventory source group. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
}
advertiserId: string, The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
partnerId: string, The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A collection of targetable inventory sources.
"displayName": "A String", # Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
"inventorySourceGroupId": "A String", # Output only. The unique ID of the inventory source group. Assigned by the system.
"name": "A String", # Output only. The resource name of the inventory source group.
}</pre>
</div>
</body></html>
|
