Debian Codegraph @

docs/dyn/displayvideo_v4.guaranteedOrders.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_v4.html">Display & Video 360 API</a> . <a href="displayvideo_v4.guaranteedOrders.html">guaranteedOrders</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new guaranteed order. Returns the newly created guaranteed order if successful.</p>
83 <p class="toc_element">
84 <code><a href="#editGuaranteedOrderReadAccessors">editGuaranteedOrderReadAccessors(guaranteedOrderId, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Edits read advertisers of a guaranteed order.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(guaranteedOrderId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a guaranteed order.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
91 <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>
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 <p class="toc_element">
96 <code><a href="#patch">patch(guaranteedOrderId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an existing guaranteed order. Returns the updated guaranteed order if successful.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
106 <pre>Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
107
108 Args:
109 body: object, The request body.
110 The object takes the form of:
111
112 { # 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.
113 &quot;defaultAdvertiserId&quot;: &quot;A String&quot;, # 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.
114 &quot;defaultCampaignId&quot;: &quot;A String&quot;, # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
115 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
116 &quot;exchange&quot;: &quot;A String&quot;, # Required. Immutable. The exchange where the guaranteed order originated.
117 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
118 &quot;legacyGuaranteedOrderId&quot;: &quot;A String&quot;, # 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.
119 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the guaranteed order.
120 &quot;publisherName&quot;: &quot;A String&quot;, # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
121 &quot;readAccessInherited&quot;: 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.
122 &quot;readAdvertiserIds&quot;: [ # 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.
123 &quot;A String&quot;,
124 ],
125 &quot;readWriteAdvertiserId&quot;: &quot;A String&quot;, # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
126 &quot;readWritePartnerId&quot;: &quot;A String&quot;, # The partner with read/write access to the guaranteed order.
127 &quot;status&quot;: { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
128 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
129 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
130 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
131 },
132 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
133 }
134
135 advertiserId: string, The ID of the advertiser that the request is being made within.
136 partnerId: string, The ID of the partner that the request is being made within.
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # 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.
146 &quot;defaultAdvertiserId&quot;: &quot;A String&quot;, # 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.
147 &quot;defaultCampaignId&quot;: &quot;A String&quot;, # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
148 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
149 &quot;exchange&quot;: &quot;A String&quot;, # Required. Immutable. The exchange where the guaranteed order originated.
150 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
151 &quot;legacyGuaranteedOrderId&quot;: &quot;A String&quot;, # 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.
152 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the guaranteed order.
153 &quot;publisherName&quot;: &quot;A String&quot;, # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
154 &quot;readAccessInherited&quot;: 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.
155 &quot;readAdvertiserIds&quot;: [ # 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.
156 &quot;A String&quot;,
157 ],
158 &quot;readWriteAdvertiserId&quot;: &quot;A String&quot;, # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
159 &quot;readWritePartnerId&quot;: &quot;A String&quot;, # The partner with read/write access to the guaranteed order.
160 &quot;status&quot;: { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
161 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
162 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
163 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
164 },
165 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
166 }</pre>
167 </div>
168
169 <div class="method">
170 <code class="details" id="editGuaranteedOrderReadAccessors">editGuaranteedOrderReadAccessors(guaranteedOrderId, body=None, x__xgafv=None)</code>
171 <pre>Edits read advertisers of a guaranteed order.
172
173 Args:
174 guaranteedOrderId: string, Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` (required)
175 body: object, The request body.
176 The object takes the form of:
177
178 { # Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.
179 &quot;addedAdvertisers&quot;: [ # The advertisers to add as read accessors to the guaranteed order.
180 &quot;A String&quot;,
181 ],
182 &quot;partnerId&quot;: &quot;A String&quot;, # Required. The partner context in which the change is being made.
183 &quot;readAccessInherited&quot;: 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.
184 &quot;removedAdvertisers&quot;: [ # The advertisers to remove as read accessors to the guaranteed order.
185 &quot;A String&quot;,
186 ],
187 }
188
189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
193
194 Returns:
195 An object of the form:
196
197 {
198 &quot;readAccessInherited&quot;: True or False, # Whether all advertisers of read_write_partner_id have read access to the guaranteed order.
199 &quot;readAdvertiserIds&quot;: [ # The IDs of advertisers with read access to the guaranteed order.
200 &quot;A String&quot;,
201 ],
202 }</pre>
203 </div>
204
205 <div class="method">
206 <code class="details" id="get">get(guaranteedOrderId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
207 <pre>Gets a guaranteed order.
208
209 Args:
210 guaranteedOrderId: string, Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}` (required)
211 advertiserId: string, The ID of the advertiser that has access to the guaranteed order.
212 partnerId: string, The ID of the partner that has access to the guaranteed order.
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218 Returns:
219 An object of the form:
220
221 { # 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.
222 &quot;defaultAdvertiserId&quot;: &quot;A String&quot;, # 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.
223 &quot;defaultCampaignId&quot;: &quot;A String&quot;, # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
224 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
225 &quot;exchange&quot;: &quot;A String&quot;, # Required. Immutable. The exchange where the guaranteed order originated.
226 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
227 &quot;legacyGuaranteedOrderId&quot;: &quot;A String&quot;, # 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.
228 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the guaranteed order.
229 &quot;publisherName&quot;: &quot;A String&quot;, # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
230 &quot;readAccessInherited&quot;: 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.
231 &quot;readAdvertiserIds&quot;: [ # 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.
232 &quot;A String&quot;,
233 ],
234 &quot;readWriteAdvertiserId&quot;: &quot;A String&quot;, # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
235 &quot;readWritePartnerId&quot;: &quot;A String&quot;, # The partner with read/write access to the guaranteed order.
236 &quot;status&quot;: { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
237 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
238 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
239 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
240 },
241 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
242 }</pre>
243 </div>
244
245 <div class="method">
246 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
247 <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.
248
249 Args:
250 advertiserId: string, The ID of the advertiser that has access to the guaranteed order.
251 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=&quot;ENTITY_STATUS_ACTIVE&quot;` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange=&quot;EXCHANGE_GOOGLE_AD_MANAGER&quot; OR exchange=&quot;EXCHANGE_RUBICON&quot;` 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.
252 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 &quot;desc&quot; should be added to the field name. For example, `displayName desc`.
253 pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
254 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.
255 partnerId: string, The ID of the partner that has access to the guaranteed order.
256 x__xgafv: string, V1 error format.
257 Allowed values
258 1 - v1 error format
259 2 - v2 error format
260
261 Returns:
262 An object of the form:
263
264 {
265 &quot;guaranteedOrders&quot;: [ # The list of guaranteed orders. This list will be absent if empty.
266 { # 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.
267 &quot;defaultAdvertiserId&quot;: &quot;A String&quot;, # 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.
268 &quot;defaultCampaignId&quot;: &quot;A String&quot;, # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
269 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
270 &quot;exchange&quot;: &quot;A String&quot;, # Required. Immutable. The exchange where the guaranteed order originated.
271 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
272 &quot;legacyGuaranteedOrderId&quot;: &quot;A String&quot;, # 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.
273 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the guaranteed order.
274 &quot;publisherName&quot;: &quot;A String&quot;, # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
275 &quot;readAccessInherited&quot;: 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.
276 &quot;readAdvertiserIds&quot;: [ # 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.
277 &quot;A String&quot;,
278 ],
279 &quot;readWriteAdvertiserId&quot;: &quot;A String&quot;, # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
280 &quot;readWritePartnerId&quot;: &quot;A String&quot;, # The partner with read/write access to the guaranteed order.
281 &quot;status&quot;: { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
282 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
283 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
284 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
285 },
286 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
287 },
288 ],
289 &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 `ListGuaranteedOrders` method to retrieve the next page of results.
290 }</pre>
291 </div>
292
293 <div class="method">
294 <code class="details" id="list_next">list_next()</code>
295 <pre>Retrieves the next page of results.
296
297 Args:
298 previous_request: The request for the previous page. (required)
299 previous_response: The response from the request for the previous page. (required)
300
301 Returns:
302 A request object that you can call &#x27;execute()&#x27; on to request the next
303 page. Returns None if there are no more items in the collection.
304 </pre>
305 </div>
306
307 <div class="method">
308 <code class="details" id="patch">patch(guaranteedOrderId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
309 <pre>Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
310
311 Args:
312 guaranteedOrderId: string, Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`. (required)
313 body: object, The request body.
314 The object takes the form of:
315
316 { # 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.
317 &quot;defaultAdvertiserId&quot;: &quot;A String&quot;, # 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.
318 &quot;defaultCampaignId&quot;: &quot;A String&quot;, # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
319 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
320 &quot;exchange&quot;: &quot;A String&quot;, # Required. Immutable. The exchange where the guaranteed order originated.
321 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
322 &quot;legacyGuaranteedOrderId&quot;: &quot;A String&quot;, # 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.
323 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the guaranteed order.
324 &quot;publisherName&quot;: &quot;A String&quot;, # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
325 &quot;readAccessInherited&quot;: 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.
326 &quot;readAdvertiserIds&quot;: [ # 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.
327 &quot;A String&quot;,
328 ],
329 &quot;readWriteAdvertiserId&quot;: &quot;A String&quot;, # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
330 &quot;readWritePartnerId&quot;: &quot;A String&quot;, # The partner with read/write access to the guaranteed order.
331 &quot;status&quot;: { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
332 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
333 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
334 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
335 },
336 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
337 }
338
339 advertiserId: string, The ID of the advertiser that the request is being made within.
340 partnerId: string, The ID of the partner that the request is being made within.
341 updateMask: string, Required. The mask to control which fields to update.
342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
346
347 Returns:
348 An object of the form:
349
350 { # 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.
351 &quot;defaultAdvertiserId&quot;: &quot;A String&quot;, # 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.
352 &quot;defaultCampaignId&quot;: &quot;A String&quot;, # The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
353 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
354 &quot;exchange&quot;: &quot;A String&quot;, # Required. Immutable. The exchange where the guaranteed order originated.
355 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
356 &quot;legacyGuaranteedOrderId&quot;: &quot;A String&quot;, # 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.
357 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the guaranteed order.
358 &quot;publisherName&quot;: &quot;A String&quot;, # Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
359 &quot;readAccessInherited&quot;: 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.
360 &quot;readAdvertiserIds&quot;: [ # 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.
361 &quot;A String&quot;,
362 ],
363 &quot;readWriteAdvertiserId&quot;: &quot;A String&quot;, # The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
364 &quot;readWritePartnerId&quot;: &quot;A String&quot;, # The partner with read/write access to the guaranteed order.
365 &quot;status&quot;: { # The status settings of the guaranteed order. # The status settings of the guaranteed order.
366 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
367 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
368 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
369 },
370 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.
371 }</pre>
372 </div>
373
374 </body></html>