Real-time Bidding API . bidders . biddingFunctions

activate(name, body=None, x__xgafv=None)

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.
  "biddingFunction": "A String", # The raw Javascript source code of the bidding function.
  "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
  "state": "A String", # Output only. The state of the bidding function.
  "type": "A String", # The type of the bidding function to be created.
}

archive(name, body=None, x__xgafv=None)

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.
  "biddingFunction": "A String", # The raw Javascript source code of the bidding function.
  "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
  "state": "A String", # Output only. The state of the bidding function.
  "type": "A String", # The type of the bidding function to be created.
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new bidding function.

Args:
  parent: string, Required. The name of the bidder for which to create the bidding function. Format: `bidders/{bidderAccountId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
  "biddingFunction": "A String", # The raw Javascript source code of the bidding function.
  "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
  "state": "A String", # Output only. The state of the bidding function.
  "type": "A String", # The type of the bidding function to be created.
}

  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.
  "biddingFunction": "A String", # The raw Javascript source code of the bidding function.
  "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
  "state": "A String", # Output only. The state of the bidding function.
  "type": "A String", # The type of the bidding function to be created.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the bidding functions that a bidder currently has registered.

Args:
  parent: string, Required. Name of the bidder whose bidding functions will be listed. Format: `bidders/{bidder_account_id}` (required)
  pageSize: integer, The maximum number of bidding functions to return.
  pageToken: string, A token identifying a page of results the server should return. This value is received from a previous `ListBiddingFunctions` call in ListBiddingFunctionsResponse.nextPageToken.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A response containing a list of a bidder's bidding functions.
  "biddingFunctions": [ # A list of a bidder's bidding functions.
    { # The bidding function to be executed as part of the TURTLEDOVE simulation experiment bidding flow.
      "biddingFunction": "A String", # The raw Javascript source code of the bidding function.
      "name": "A String", # The name of the bidding function that must follow the pattern: `bidders/{bidder_account_id}/biddingFunctions/{bidding_function_name}`.
      "state": "A String", # Output only. The state of the bidding function.
      "type": "A String", # The type of the bidding function to be created.
    },
  ],
  "nextPageToken": "A String", # A token which can be passed to a subsequent call to the `ListBiddingFunctions` method to retrieve the next page of results in ListBiddingFunctionsRequest.pageToken.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.