Debian Codegraph @

docs/dyn/displayvideo_v4.customBiddingAlgorithms.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.customBiddingAlgorithms.html">customBiddingAlgorithms</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="displayvideo_v4.customBiddingAlgorithms.rules.html">rules()</a></code>
79 </p>
80 <p class="firstline">Returns the rules Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="displayvideo_v4.customBiddingAlgorithms.scripts.html">scripts()</a></code>
84 </p>
85 <p class="firstline">Returns the scripts Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
92 <p class="firstline">Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.</p>
93 <p class="toc_element">
94 <code><a href="#get">get(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">Gets a custom bidding algorithm.</p>
96 <p class="toc_element">
97 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
98 <p class="firstline">Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.</p>
99 <p class="toc_element">
100 <code><a href="#list_next">list_next()</a></code></p>
101 <p class="firstline">Retrieves the next page of results.</p>
102 <p class="toc_element">
103 <code><a href="#patch">patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
104 <p class="firstline">Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.</p>
105 <p class="toc_element">
106 <code><a href="#uploadRules">uploadRules(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.</p>
108 <p class="toc_element">
109 <code><a href="#uploadScript">uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
110 <p class="firstline">Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.</p>
111 <h3>Method Details</h3>
112 <div class="method">
113 <code class="details" id="close">close()</code>
114 <pre>Close httplib2 connections.</pre>
115 </div>
116
117 <div class="method">
118 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
119 <pre>Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
120
121 Args:
122 body: object, The request body.
123 The object takes the form of:
124
125 { # A single custom bidding algorithm.
126 &quot;advertiserId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
127 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
128 &quot;customBiddingAlgorithmType&quot;: &quot;A String&quot;, # Required. Immutable. The type of custom bidding algorithm.
129 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
130 &quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
131 &quot;modelDetails&quot;: [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
132 { # The details of a custom bidding algorithm model for a single shared advertiser.
133 &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the relevant advertiser.
134 &quot;readinessState&quot;: &quot;A String&quot;, # The readiness state of custom bidding model.
135 &quot;suspensionState&quot;: &quot;A String&quot;, # Output only. The suspension state of custom bidding model.
136 },
137 ],
138 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding algorithm.
139 &quot;partnerId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
140 &quot;sharedAdvertiserIds&quot;: [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
141 &quot;A String&quot;,
142 ],
143 &quot;thirdPartyOptimizationPartner&quot;: &quot;A String&quot;, # Optional. Immutable. Designates the third party optimization partner that manages this algorithm.
144 }
145
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151 Returns:
152 An object of the form:
153
154 { # A single custom bidding algorithm.
155 &quot;advertiserId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
156 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
157 &quot;customBiddingAlgorithmType&quot;: &quot;A String&quot;, # Required. Immutable. The type of custom bidding algorithm.
158 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
159 &quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
160 &quot;modelDetails&quot;: [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
161 { # The details of a custom bidding algorithm model for a single shared advertiser.
162 &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the relevant advertiser.
163 &quot;readinessState&quot;: &quot;A String&quot;, # The readiness state of custom bidding model.
164 &quot;suspensionState&quot;: &quot;A String&quot;, # Output only. The suspension state of custom bidding model.
165 },
166 ],
167 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding algorithm.
168 &quot;partnerId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
169 &quot;sharedAdvertiserIds&quot;: [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
170 &quot;A String&quot;,
171 ],
172 &quot;thirdPartyOptimizationPartner&quot;: &quot;A String&quot;, # Optional. Immutable. Designates the third party optimization partner that manages this algorithm.
173 }</pre>
174 </div>
175
176 <div class="method">
177 <code class="details" id="get">get(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
178 <pre>Gets a custom bidding algorithm.
179
180 Args:
181 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm to fetch. (required)
182 advertiserId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
183 partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189 Returns:
190 An object of the form:
191
192 { # A single custom bidding algorithm.
193 &quot;advertiserId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
194 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
195 &quot;customBiddingAlgorithmType&quot;: &quot;A String&quot;, # Required. Immutable. The type of custom bidding algorithm.
196 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
197 &quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
198 &quot;modelDetails&quot;: [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
199 { # The details of a custom bidding algorithm model for a single shared advertiser.
200 &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the relevant advertiser.
201 &quot;readinessState&quot;: &quot;A String&quot;, # The readiness state of custom bidding model.
202 &quot;suspensionState&quot;: &quot;A String&quot;, # Output only. The suspension state of custom bidding model.
203 },
204 ],
205 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding algorithm.
206 &quot;partnerId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
207 &quot;sharedAdvertiserIds&quot;: [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
208 &quot;A String&quot;,
209 ],
210 &quot;thirdPartyOptimizationPartner&quot;: &quot;A String&quot;, # Optional. Immutable. Designates the third party optimization partner that manages this algorithm.
211 }</pre>
212 </div>
213
214 <div class="method">
215 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
216 <pre>Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
217
218 Args:
219 advertiserId: string, The ID of the DV360 advertiser that has access to the custom bidding algorithm.
220 filter: string, Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains &quot;politics&quot;: `displayName:&quot;politics&quot;`. * All custom bidding algorithms for which the type is &quot;SCRIPT_BASED&quot;: `customBiddingAlgorithmType=SCRIPT_BASED` 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.
221 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. Example: `displayName desc`.
222 pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
223 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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
224 partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
229
230 Returns:
231 An object of the form:
232
233 {
234 &quot;customBiddingAlgorithms&quot;: [ # The list of custom bidding algorithms. This list will be absent if empty.
235 { # A single custom bidding algorithm.
236 &quot;advertiserId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
237 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
238 &quot;customBiddingAlgorithmType&quot;: &quot;A String&quot;, # Required. Immutable. The type of custom bidding algorithm.
239 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
240 &quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
241 &quot;modelDetails&quot;: [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
242 { # The details of a custom bidding algorithm model for a single shared advertiser.
243 &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the relevant advertiser.
244 &quot;readinessState&quot;: &quot;A String&quot;, # The readiness state of custom bidding model.
245 &quot;suspensionState&quot;: &quot;A String&quot;, # Output only. The suspension state of custom bidding model.
246 },
247 ],
248 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding algorithm.
249 &quot;partnerId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
250 &quot;sharedAdvertiserIds&quot;: [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
251 &quot;A String&quot;,
252 ],
253 &quot;thirdPartyOptimizationPartner&quot;: &quot;A String&quot;, # Optional. Immutable. Designates the third party optimization partner that manages this algorithm.
254 },
255 ],
256 &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 `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
257 }</pre>
258 </div>
259
260 <div class="method">
261 <code class="details" id="list_next">list_next()</code>
262 <pre>Retrieves the next page of results.
263
264 Args:
265 previous_request: The request for the previous page. (required)
266 previous_response: The response from the request for the previous page. (required)
267
268 Returns:
269 A request object that you can call &#x27;execute()&#x27; on to request the next
270 page. Returns None if there are no more items in the collection.
271 </pre>
272 </div>
273
274 <div class="method">
275 <code class="details" id="patch">patch(customBiddingAlgorithmId, body=None, updateMask=None, x__xgafv=None)</code>
276 <pre>Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.
277
278 Args:
279 customBiddingAlgorithmId: string, Output only. The unique ID of the custom bidding algorithm. Assigned by the system. (required)
280 body: object, The request body.
281 The object takes the form of:
282
283 { # A single custom bidding algorithm.
284 &quot;advertiserId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
285 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
286 &quot;customBiddingAlgorithmType&quot;: &quot;A String&quot;, # Required. Immutable. The type of custom bidding algorithm.
287 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
288 &quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
289 &quot;modelDetails&quot;: [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
290 { # The details of a custom bidding algorithm model for a single shared advertiser.
291 &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the relevant advertiser.
292 &quot;readinessState&quot;: &quot;A String&quot;, # The readiness state of custom bidding model.
293 &quot;suspensionState&quot;: &quot;A String&quot;, # Output only. The suspension state of custom bidding model.
294 },
295 ],
296 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding algorithm.
297 &quot;partnerId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
298 &quot;sharedAdvertiserIds&quot;: [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
299 &quot;A String&quot;,
300 ],
301 &quot;thirdPartyOptimizationPartner&quot;: &quot;A String&quot;, # Optional. Immutable. Designates the third party optimization partner that manages this algorithm.
302 }
303
304 updateMask: string, Required. The mask to control which fields to update.
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310 Returns:
311 An object of the form:
312
313 { # A single custom bidding algorithm.
314 &quot;advertiserId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
315 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
316 &quot;customBiddingAlgorithmType&quot;: &quot;A String&quot;, # Required. Immutable. The type of custom bidding algorithm.
317 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
318 &quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
319 &quot;modelDetails&quot;: [ # Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
320 { # The details of a custom bidding algorithm model for a single shared advertiser.
321 &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the relevant advertiser.
322 &quot;readinessState&quot;: &quot;A String&quot;, # The readiness state of custom bidding model.
323 &quot;suspensionState&quot;: &quot;A String&quot;, # Output only. The suspension state of custom bidding model.
324 },
325 ],
326 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding algorithm.
327 &quot;partnerId&quot;: &quot;A String&quot;, # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
328 &quot;sharedAdvertiserIds&quot;: [ # The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
329 &quot;A String&quot;,
330 ],
331 &quot;thirdPartyOptimizationPartner&quot;: &quot;A String&quot;, # Optional. Immutable. Designates the third party optimization partner that manages this algorithm.
332 }</pre>
333 </div>
334
335 <div class="method">
336 <code class="details" id="uploadRules">uploadRules(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
337 <pre>Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.
338
339 Args:
340 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
341 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
342 partnerId: string, The ID of the partner that owns the parent custom bidding algorithm.
343 x__xgafv: string, V1 error format.
344 Allowed values
345 1 - v1 error format
346 2 - v2 error format
347
348 Returns:
349 An object of the form:
350
351 { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules.
352 &quot;resourceName&quot;: &quot;A String&quot;, # A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
353 }</pre>
354 </div>
355
356 <div class="method">
357 <code class="details" id="uploadScript">uploadScript(customBiddingAlgorithmId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
358 <pre>Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.
359
360 Args:
361 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required)
362 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
363 partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
364 x__xgafv: string, V1 error format.
365 Allowed values
366 1 - v1 error format
367 2 - v2 error format
368
369 Returns:
370 An object of the form:
371
372 { # The reference to the uploaded custom bidding script file.
373 &quot;resourceName&quot;: &quot;A String&quot;, # A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
374 }</pre>
375 </div>
376
377 </body></html>