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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
<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_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.guaranteedOrders.html">guaranteedOrders</a></h1>
<h2>Instance Methods</h2>
<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 guaranteed order. Returns the newly created guaranteed order if successful.</p>
<p class="toc_element">
<code><a href="#editGuaranteedOrderReadAccessors">editGuaranteedOrderReadAccessors(guaranteedOrderId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Edits read advertisers of a guaranteed order.</p>
<p class="toc_element">
<code><a href="#get">get(guaranteedOrderId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a guaranteed order.</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 guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.</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(guaranteedOrderId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing guaranteed order. Returns the updated guaranteed order 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 guaranteed order. Returns the newly created guaranteed order if successful.
Args:
body: object, The request body.
The object takes the form of:
{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
"defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
"defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
"displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
"guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
"legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
"name": "A String", # Output only. The resource name of the guaranteed order.
"publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
"A String",
],
"readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
"readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
"status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
"configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
"entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
},
"updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
}
advertiserId: string, The ID of the advertiser that the request is being made within.
partnerId: string, The ID of the partner that the request is being made within.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
"defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
"defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
"displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
"guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
"legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
"name": "A String", # Output only. The resource name of the guaranteed order.
"publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
"A String",
],
"readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
"readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
"status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
"configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
"entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
},
"updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="editGuaranteedOrderReadAccessors">editGuaranteedOrderReadAccessors(guaranteedOrderId, body=None, x__xgafv=None)</code>
<pre>Edits read advertisers of a guaranteed order.
Args:
guaranteedOrderId: string, Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.
"addedAdvertisers": [ # The advertisers to add as read accessors to the guaranteed order.
"A String",
],
"partnerId": "A String", # Required. The partner context in which the change is being made.
"readAccessInherited": True or False, # Whether to give all advertisers of the read/write accessor partner read access to the guaranteed order. Only applicable if read_write_partner_id is set in the guaranteed order.
"removedAdvertisers": [ # The advertisers to remove as read accessors to the guaranteed order.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(guaranteedOrderId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
<pre>Gets a guaranteed order.
Args:
guaranteedOrderId: string, Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` (required)
advertiserId: string, The ID of the advertiser that has access to the guaranteed order.
partnerId: string, The ID of the partner that has access to the guaranteed order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
"defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
"defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
"displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
"guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
"legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
"name": "A String", # Output only. The resource name of the guaranteed order.
"publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
"A String",
],
"readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
"readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
"status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
"configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
"entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
},
"updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
}</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 guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Args:
advertiserId: string, The ID of the advertiser that has access to the guaranteed order.
filter: string, Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` 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) 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 `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
partnerId: string, The ID of the partner that has access to the guaranteed order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"guaranteedOrders": [ # The list of guaranteed orders. This list will be absent if empty.
{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
"defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
"defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
"displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
"guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
"legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
"name": "A String", # Output only. The resource name of the guaranteed order.
"publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
"A String",
],
"readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
"readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
"status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
"configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
"entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
},
"updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
},
],
"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 `ListGuaranteedOrders` 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(guaranteedOrderId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Args:
guaranteedOrderId: string, Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
"defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
"defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
"displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
"guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
"legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
"name": "A String", # Output only. The resource name of the guaranteed order.
"publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
"A String",
],
"readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
"readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
"status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
"configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
"entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
},
"updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
}
advertiserId: string, The ID of the advertiser that the request is being made within.
partnerId: string, The ID of the partner that the request is being made within.
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 guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.
"defaultAdvertiserId": "A String", # Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
"defaultCampaignId": "A String", # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
"displayName": "A String", # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # Required. Immutable. The exchange where the guaranteed order originated.
"guaranteedOrderId": "A String", # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
"legacyGuaranteedOrderId": "A String", # Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
"name": "A String", # Output only. The resource name of the guaranteed order.
"publisherName": "A String", # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
"readAccessInherited": True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
"readAdvertiserIds": [ # The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
"A String",
],
"readWriteAdvertiserId": "A String", # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
"readWritePartnerId": "A String", # The partner with read/write access to the guaranteed order.
"status": { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
"configStatus": "A String", # Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
"entityPauseReason": "A String", # The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
},
"updateTime": "A String", # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
}</pre>
</div>
</body></html>
|
