Debian Codegraph @

docs/dyn/displayvideo_v4.customBiddingAlgorithms.scripts.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> . <a href="displayvideo_v4.customBiddingAlgorithms.scripts.html">scripts</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(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets a custom bidding script.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="create">create(customBiddingAlgorithmId, advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
100 <pre>Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.
101
102 Args:
103 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the script. (required)
104 body: object, The request body.
105 The object takes the form of:
106
107 { # A single custom bidding script.
108 &quot;active&quot;: True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
109 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the script was created.
110 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm the script belongs to.
111 &quot;customBiddingScriptId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding script.
112 &quot;errors&quot;: [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
113 { # An error message for a custom bidding script.
114 &quot;column&quot;: &quot;A String&quot;, # The column number in the script where the error was thrown.
115 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
116 &quot;errorMessage&quot;: &quot;A String&quot;, # The detailed error message.
117 &quot;line&quot;: &quot;A String&quot;, # The line number in the script where the error was thrown.
118 },
119 ],
120 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding script.
121 &quot;script&quot;: { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
122 &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}`.
123 },
124 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the custom bidding script.
125 }
126
127 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
128 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.
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134 Returns:
135 An object of the form:
136
137 { # A single custom bidding script.
138 &quot;active&quot;: True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
139 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the script was created.
140 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm the script belongs to.
141 &quot;customBiddingScriptId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding script.
142 &quot;errors&quot;: [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
143 { # An error message for a custom bidding script.
144 &quot;column&quot;: &quot;A String&quot;, # The column number in the script where the error was thrown.
145 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
146 &quot;errorMessage&quot;: &quot;A String&quot;, # The detailed error message.
147 &quot;line&quot;: &quot;A String&quot;, # The line number in the script where the error was thrown.
148 },
149 ],
150 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding script.
151 &quot;script&quot;: { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
152 &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}`.
153 },
154 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the custom bidding script.
155 }</pre>
156 </div>
157
158 <div class="method">
159 <code class="details" id="get">get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
160 <pre>Gets a custom bidding script.
161
162 Args:
163 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required)
164 customBiddingScriptId: string, Required. The ID of the custom bidding script to fetch. (required)
165 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
166 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.
167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172 Returns:
173 An object of the form:
174
175 { # A single custom bidding script.
176 &quot;active&quot;: True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
177 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the script was created.
178 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm the script belongs to.
179 &quot;customBiddingScriptId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding script.
180 &quot;errors&quot;: [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
181 { # An error message for a custom bidding script.
182 &quot;column&quot;: &quot;A String&quot;, # The column number in the script where the error was thrown.
183 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
184 &quot;errorMessage&quot;: &quot;A String&quot;, # The detailed error message.
185 &quot;line&quot;: &quot;A String&quot;, # The line number in the script where the error was thrown.
186 },
187 ],
188 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding script.
189 &quot;script&quot;: { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
190 &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}`.
191 },
192 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the custom bidding script.
193 }</pre>
194 </div>
195
196 <div class="method">
197 <code class="details" id="list">list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
198 <pre>Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
199
200 Args:
201 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm owns the script. (required)
202 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
203 orderBy: string, Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix &quot;desc&quot; should be removed. Example: `createTime`.
204 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.
205 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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
206 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.
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212 Returns:
213 An object of the form:
214
215 {
216 &quot;customBiddingScripts&quot;: [ # The list of custom bidding scripts. This list will be absent if empty.
217 { # A single custom bidding script.
218 &quot;active&quot;: True or False, # Output only. Whether the script is currently being used for scoring by the parent algorithm.
219 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the script was created.
220 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm the script belongs to.
221 &quot;customBiddingScriptId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding script.
222 &quot;errors&quot;: [ # Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.
223 { # An error message for a custom bidding script.
224 &quot;column&quot;: &quot;A String&quot;, # The column number in the script where the error was thrown.
225 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
226 &quot;errorMessage&quot;: &quot;A String&quot;, # The detailed error message.
227 &quot;line&quot;: &quot;A String&quot;, # The line number in the script where the error was thrown.
228 },
229 ],
230 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the custom bidding script.
231 &quot;script&quot;: { # The reference to the uploaded custom bidding script file. # The reference to the uploaded script file.
232 &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}`.
233 },
234 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the custom bidding script.
235 },
236 ],
237 &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 `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
238 }</pre>
239 </div>
240
241 <div class="method">
242 <code class="details" id="list_next">list_next()</code>
243 <pre>Retrieves the next page of results.
244
245 Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249 Returns:
250 A request object that you can call &#x27;execute()&#x27; on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253 </div>
254
255 </body></html>