Skip to content

Commit

Permalink
feat(realtimebidding): update the api
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
yoshi-automation committed Jun 29, 2021
1 parent 502a967 commit fd514dc
Show file tree
Hide file tree
Showing 3 changed files with 150 additions and 2 deletions.
65 changes: 65 additions & 0 deletions docs/dyn/realtimebidding_v1alpha.bidders.biddingFunctions.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.</p>
<p class="toc_element">
<code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand All @@ -87,6 +93,62 @@ <h2>Instance Methods</h2>
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code>
<pre>Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.

Args:
name: string, Required. The name of the bidding function to activate. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}` (required)
body: object, The request body.
The object takes the form of:

{ # The request to activate a bidding function.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
&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}`.
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
}</pre>
</div>

<div class="method">
<code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code>
<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.

Args:
name: string, Required. The name of the bidding function to archive. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}` (required)
body: object, The request body.
The object takes the form of:

{ # A request to archive a bidding function.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
&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}`.
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
}</pre>
</div>

<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
Expand All @@ -104,6 +166,7 @@ <h3>Method Details</h3>
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
&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}`.
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
}

Expand All @@ -118,6 +181,7 @@ <h3>Method Details</h3>
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
&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}`.
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
}</pre>
</div>
Expand All @@ -143,6 +207,7 @@ <h3>Method Details</h3>
{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
&quot;biddingFunction&quot;: &quot;A String&quot;, # The raw Javascript source code of the bidding function.
&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}`.
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the bidding function.
&quot;type&quot;: &quot;A String&quot;, # The type of the bidding function to be created.
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,7 @@
}
}
},
"revision": "20210615",
"revision": "20210626",
"rootUrl": "https://realtimebidding.googleapis.com/",
"schemas": {
"ActivatePretargetingConfigRequest": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,62 @@
"resources": {
"biddingFunctions": {
"methods": {
"activate": {
"description": "Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.",
"flatPath": "v1alpha/bidders/{biddersId}/biddingFunctions/{biddingFunctionsId}:activate",
"httpMethod": "POST",
"id": "realtimebidding.bidders.biddingFunctions.activate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the bidding function to activate. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}`",
"location": "path",
"pattern": "^bidders/[^/]+/biddingFunctions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:activate",
"request": {
"$ref": "ActivateBiddingFunctionRequest"
},
"response": {
"$ref": "BiddingFunction"
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
]
},
"archive": {
"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.",
"flatPath": "v1alpha/bidders/{biddersId}/biddingFunctions/{biddingFunctionsId}:archive",
"httpMethod": "POST",
"id": "realtimebidding.bidders.biddingFunctions.archive",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the bidding function to archive. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}`",
"location": "path",
"pattern": "^bidders/[^/]+/biddingFunctions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:archive",
"request": {
"$ref": "ArchiveBiddingFunctionRequest"
},
"response": {
"$ref": "BiddingFunction"
},
"scopes": [
"https://www.googleapis.com/auth/realtime-bidding"
]
},
"create": {
"description": "Creates a new bidding function.",
"flatPath": "v1alpha/bidders/{biddersId}/biddingFunctions",
Expand Down Expand Up @@ -178,9 +234,21 @@
}
}
},
"revision": "20210615",
"revision": "20210624",
"rootUrl": "https://realtimebidding.googleapis.com/",
"schemas": {
"ActivateBiddingFunctionRequest": {
"description": "The request to activate a bidding function.",
"id": "ActivateBiddingFunctionRequest",
"properties": {},
"type": "object"
},
"ArchiveBiddingFunctionRequest": {
"description": "A request to archive a bidding function.",
"id": "ArchiveBiddingFunctionRequest",
"properties": {},
"type": "object"
},
"BiddingFunction": {
"description": "The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.",
"id": "BiddingFunction",
Expand All @@ -193,6 +261,21 @@
"description": "The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.",
"type": "string"
},
"state": {
"description": "Output only. The state of the bidding function.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"ARCHIVED"
],
"enumDescriptions": [
"Default value that should not be used.",
"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.",
"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`."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "The type of the bidding function to be created.",
"enum": [
Expand Down

0 comments on commit fd514dc

Please sign in to comment.