Debian Codegraph @

docs/dyn/displayvideo_v3.customBiddingAlgorithms.rules.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_v3.html">Display & Video 360 API</a> . <a href="displayvideo_v3.customBiddingAlgorithms.html">customBiddingAlgorithms</a> . <a href="displayvideo_v3.customBiddingAlgorithms.rules.html">rules</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 rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource 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, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a rules resource.</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 rules resources 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 rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource 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 rules resource. (required)
104 body: object, The request body.
105 The object takes the form of:
106
107 { # A single custom bidding algorithm rules.
108 &quot;active&quot;: True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
109 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the rules resource was created.
110 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
111 &quot;customBiddingAlgorithmRulesId&quot;: &quot;A String&quot;, # Output only. The unique ID of the rules resource.
112 &quot;error&quot;: { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
113 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
114 },
115 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the rules resource.
116 &quot;rules&quot;: { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
117 &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}`.
118 },
119 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the rules resource.
120 }
121
122 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
123 partnerId: string, The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # A single custom bidding algorithm rules.
133 &quot;active&quot;: True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
134 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the rules resource was created.
135 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
136 &quot;customBiddingAlgorithmRulesId&quot;: &quot;A String&quot;, # Output only. The unique ID of the rules resource.
137 &quot;error&quot;: { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
138 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
139 },
140 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the rules resource.
141 &quot;rules&quot;: { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
142 &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}`.
143 },
144 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the rules resource.
145 }</pre>
146 </div>
147
148 <div class="method">
149 <code class="details" id="get">get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
150 <pre>Retrieves a rules resource.
151
152 Args:
153 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
154 customBiddingAlgorithmRulesId: string, Required. The ID of the rules resource to fetch. (required)
155 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
156 partnerId: string, The ID of the partner that owns the parent custom bidding algorithm.
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162 Returns:
163 An object of the form:
164
165 { # A single custom bidding algorithm rules.
166 &quot;active&quot;: True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
167 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the rules resource was created.
168 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
169 &quot;customBiddingAlgorithmRulesId&quot;: &quot;A String&quot;, # Output only. The unique ID of the rules resource.
170 &quot;error&quot;: { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
171 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
172 },
173 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the rules resource.
174 &quot;rules&quot;: { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
175 &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}`.
176 },
177 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the rules resource.
178 }</pre>
179 </div>
180
181 <div class="method">
182 <code class="details" id="list">list(customBiddingAlgorithmId, advertiserId=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
183 <pre>Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
184
185 Args:
186 customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm that owns the rules resource. (required)
187 advertiserId: string, The ID of the advertiser that owns the parent custom bidding algorithm.
188 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`.
189 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.
190 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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
191 partnerId: string, The ID of the partner that owns the parent custom bidding algorithm.
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196
197 Returns:
198 An object of the form:
199
200 {
201 &quot;customBiddingRules&quot;: [ # The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty.
202 { # A single custom bidding algorithm rules.
203 &quot;active&quot;: True or False, # Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
204 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the rules resource was created.
205 &quot;customBiddingAlgorithmId&quot;: &quot;A String&quot;, # Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
206 &quot;customBiddingAlgorithmRulesId&quot;: &quot;A String&quot;, # Output only. The unique ID of the rules resource.
207 &quot;error&quot;: { # An error message for a CustomBiddingAlgorithmRules resource. # Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.
208 &quot;errorCode&quot;: &quot;A String&quot;, # The type of error.
209 },
210 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the rules resource.
211 &quot;rules&quot;: { # The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. # Required. Immutable. The reference to the uploaded AlgorithmRules file.
212 &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}`.
213 },
214 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the rules resource.
215 },
216 ],
217 &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 `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
218 }</pre>
219 </div>
220
221 <div class="method">
222 <code class="details" id="list_next">list_next()</code>
223 <pre>Retrieves the next page of results.
224
225 Args:
226 previous_request: The request for the previous page. (required)
227 previous_response: The response from the request for the previous page. (required)
228
229 Returns:
230 A request object that you can call &#x27;execute()&#x27; on to request the next
231 page. Returns None if there are no more items in the collection.
232 </pre>
233 </div>
234
235 </body></html>