2023-06-09
▼ ▲ realtimebidding.bidders.biddingFunctions.activate
Description: Activates an existing bidding function. An activated function is available for invocation for the server-side TURTLEDOVE simulations.
Flat Path: v1alpha/bidders/{biddersId}/biddingFunctions/{biddingFunctionsId}:activate
Parameters:
name
Type: string
Required: Yes
Description: Required. The name of the bidding function to activate. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}`
Location: path
Pattern: ^bidders/[^/]+/biddingFunctions/[^/]+$
Path: v1alpha/{+name}:activate
Parameter Order: name
HTTP Method: POST
▼ ▲ realtimebidding.bidders.biddingFunctions.list
Flat Path: v1alpha/bidders/{biddersId}/biddingFunctions
Parameters:
pageToken
Description: A token identifying a page of results the server should return. This value is received from a previous `ListBiddingFunctions` call in ListBiddingFunctionsResponse.nextPageToken.
Location: query
Type: string
parent
Location: path
Required: Yes
Type: string
Pattern: ^bidders/[^/]+$
Description: Required. Name of the bidder whose bidding functions will be listed. Format: `bidders/{bidder_account_id}`
pageSize
Description: The maximum number of bidding functions to return.
Format: int32
Location: query
Type: integer
Parameter Order: parent
Description: Lists the bidding functions that a bidder currently has registered.
Scopes: https://www.googleapis.com/auth/realtime-bidding
HTTP Method: GET
Path: v1alpha/{+parent}/biddingFunctions
▼ ▲ realtimebidding.bidders.biddingFunctions.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.
Scopes: https://www.googleapis.com/auth/realtime-bidding
Path: v1alpha/{+name}:archive
Parameters:
name
Location: path
Pattern: ^bidders/[^/]+/biddingFunctions/[^/]+$
Description: Required. The name of the bidding function to archive. Format: `bidders/{bidder_account_id}/biddingFunction/{bidding_function_name}`
Type: string
Required: Yes
Flat Path: v1alpha/bidders/{biddersId}/biddingFunctions/{biddingFunctionsId}:archive
HTTP Method: POST
Parameter Order: name
▼ ▲ realtimebidding.bidders.biddingFunctions.create
HTTP Method: POST
Parameter Order: parent
Description: Creates a new bidding function.
Scopes: https://www.googleapis.com/auth/realtime-bidding
Parameters:
parent
Description: Required. The name of the bidder for which to create the bidding function. Format: `bidders/{bidderAccountId}`
Location: path
Type: string
Pattern: ^bidders/[^/]+$
Required: Yes
Path: v1alpha/{+parent}/biddingFunctions
Flat Path: v1alpha/bidders/{biddersId}/biddingFunctions