Skip to content

Commit fd514dc

Browse files
yoshi-automationyoshi-automation
committed
feat(realtimebidding): update the api
#### realtimebidding:v1alpha The following keys were added: - resources.bidders.resources.biddingFunctions.methods.activate (Total Keys: 12) - resources.bidders.resources.biddingFunctions.methods.archive (Total Keys: 12) - schemas.ActivateBiddingFunctionRequest (Total Keys: 2) - schemas.ArchiveBiddingFunctionRequest (Total Keys: 2) - schemas.BiddingFunction.properties.state (Total Keys: 2)
1 parent 502a967 commit fd514dc

File tree

3 files changed

+150
-2
lines changed

3 files changed

+150
-2
lines changed

‎docs/dyn/realtimebidding_v1alpha.bidders.biddingFunctions.html

+65
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@
7474

7575
<h1><a href="realtimebidding_v1alpha.html">Real-time Bidding API</a> . <a href="realtimebidding_v1alpha.bidders.html">bidders</a> . <a href="realtimebidding_v1alpha.bidders.biddingFunctions.html">biddingFunctions</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.</p>
80+
<p class="toc_element">
81+
<code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Archives an existing bidding function. An archived function will not be available for function invocation for the server-side TURTLEDOVE simulations unless it is activated.</p>
7783
<p class="toc_element">
7884
<code><a href="#close">close()</a></code></p>
7985
<p class="firstline">Close httplib2 connections.</p>
@@ -87,6 +93,62 @@ <h2>Instance Methods</h2>
8793
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
8894
<p class="firstline">Retrieves the next page of results.</p>
8995
<h3>Method Details</h3>
96+
<div class="method">
97+
<code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code>
98+
<pre>Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.
99+
100+
Args:
101+
name: string, Required. The name of the bidding function to activate. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}` (required)
102+
body: object, The request body.
103+
The object takes the form of:
104+
105+
{ # The request to activate a bidding function.
106+
}
107+
108+
x__xgafv: string, V1 error format.
109+
Allowed values
110+
1 - v1 error format
111+
2 - v2 error format
112+
113+
Returns:
114+
An object of the form:
115+
116+
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
117+
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
118+
&quot;name&quot;: &quot;A String&quot;, # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
119+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
120+
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
121+
}</pre>
122+
</div>
123+
124+
<div class="method">
125+
<code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code>
126+
<pre>Archives an existing bidding function. An archived function will not be available for function invocation for the server-side TURTLEDOVE simulations unless it is activated.
127+
128+
Args:
129+
name: string, Required. The name of the bidding function to archive. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}` (required)
130+
body: object, The request body.
131+
The object takes the form of:
132+
133+
{ # A request to archive a bidding function.
134+
}
135+
136+
x__xgafv: string, V1 error format.
137+
Allowed values
138+
1 - v1 error format
139+
2 - v2 error format
140+
141+
Returns:
142+
An object of the form:
143+
144+
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
145+
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
146+
&quot;name&quot;: &quot;A String&quot;, # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
147+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
148+
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
149+
}</pre>
150+
</div>
151+
90152
<div class="method">
91153
<code class="details" id="close">close()</code>
92154
<pre>Close httplib2 connections.</pre>
@@ -104,6 +166,7 @@ <h3>Method Details</h3>
104166
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
105167
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
106168
&quot;name&quot;: &quot;A String&quot;, # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
169+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
107170
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
108171
}
109172

@@ -118,6 +181,7 @@ <h3>Method Details</h3>
118181
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
119182
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
120183
&quot;name&quot;: &quot;A String&quot;, # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
184+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
121185
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
122186
}</pre>
123187
</div>
@@ -143,6 +207,7 @@ <h3>Method Details</h3>
143207
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
144208
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
145209
&quot;name&quot;: &quot;A String&quot;, # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
210+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
146211
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
147212
},
148213
],

‎googleapiclient/discovery_cache/documents/realtimebidding.v1.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1140,7 +1140,7 @@
11401140
}
11411141
}
11421142
},
1143-
"revision": "20210615",
1143+
"revision": "20210626",
11441144
"rootUrl": "https://realtimebidding.googleapis.com/",
11451145
"schemas": {
11461146
"ActivatePretargetingConfigRequest": {

‎googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json

+84-1
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,62 @@
109109
"resources": {
110110
"biddingFunctions": {
111111
"methods": {
112+
"activate": {
113+
"description": "Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.",
114+
"flatPath": "v1alpha/bidders/{biddersId}/biddingFunctions/{biddingFunctionsId}:activate",
115+
"httpMethod": "POST",
116+
"id": "realtimebidding.bidders.biddingFunctions.activate",
117+
"parameterOrder": [
118+
"name"
119+
],
120+
"parameters": {
121+
"name": {
122+
"description": "Required. The name of the bidding function to activate. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}`",
123+
"location": "path",
124+
"pattern": "^bidders/[^/]+/biddingFunctions/[^/]+$",
125+
"required": true,
126+
"type": "string"
127+
}
128+
},
129+
"path": "v1alpha/{+name}:activate",
130+
"request": {
131+
"$ref": "ActivateBiddingFunctionRequest"
132+
},
133+
"response": {
134+
"$ref": "BiddingFunction"
135+
},
136+
"scopes": [
137+
"https://www.googleapis.com/auth/realtime-bidding"
138+
]
139+
},
140+
"archive": {
141+
"description": "Archives an existing bidding function. An archived function will not be available for function invocation for the server-side TURTLEDOVE simulations unless it is activated.",
142+
"flatPath": "v1alpha/bidders/{biddersId}/biddingFunctions/{biddingFunctionsId}:archive",
143+
"httpMethod": "POST",
144+
"id": "realtimebidding.bidders.biddingFunctions.archive",
145+
"parameterOrder": [
146+
"name"
147+
],
148+
"parameters": {
149+
"name": {
150+
"description": "Required. The name of the bidding function to archive. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}`",
151+
"location": "path",
152+
"pattern": "^bidders/[^/]+/biddingFunctions/[^/]+$",
153+
"required": true,
154+
"type": "string"
155+
}
156+
},
157+
"path": "v1alpha/{+name}:archive",
158+
"request": {
159+
"$ref": "ArchiveBiddingFunctionRequest"
160+
},
161+
"response": {
162+
"$ref": "BiddingFunction"
163+
},
164+
"scopes": [
165+
"https://www.googleapis.com/auth/realtime-bidding"
166+
]
167+
},
112168
"create": {
113169
"description": "Creates a new bidding function.",
114170
"flatPath": "v1alpha/bidders/{biddersId}/biddingFunctions",
@@ -178,9 +234,21 @@
178234
}
179235
}
180236
},
181-
"revision": "20210615",
237+
"revision": "20210624",
182238
"rootUrl": "https://realtimebidding.googleapis.com/",
183239
"schemas": {
240+
"ActivateBiddingFunctionRequest": {
241+
"description": "The request to activate a bidding function.",
242+
"id": "ActivateBiddingFunctionRequest",
243+
"properties": {},
244+
"type": "object"
245+
},
246+
"ArchiveBiddingFunctionRequest": {
247+
"description": "A request to archive a bidding function.",
248+
"id": "ArchiveBiddingFunctionRequest",
249+
"properties": {},
250+
"type": "object"
251+
},
184252
"BiddingFunction": {
185253
"description": "The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.",
186254
"id": "BiddingFunction",
@@ -193,6 +261,21 @@
193261
"description": "The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.",
194262
"type": "string"
195263
},
264+
"state": {
265+
"description": "Output only. The state of the bidding function.",
266+
"enum": [
267+
"STATE_UNSPECIFIED",
268+
"ACTIVE",
269+
"ARCHIVED"
270+
],
271+
"enumDescriptions": [
272+
"Default value that should not be used.",
273+
"An active function. Only `ACTIVE` bidding functions or ad scoring functions are made available for the server-side TURTLEDOVE simulations. Every account is limited to 10 active bidding functions per account.",
274+
"A function that is no longer made available for invocation in a simulation and instead archived. An archived function can later be made active by activating the function via `ActivateBiddingFunction`."
275+
],
276+
"readOnly": true,
277+
"type": "string"
278+
},
196279
"type": {
197280
"description": "The type of the bidding function to be created.",
198281
"enum": [

0 commit comments

Comments
 (0)