Real-time Bidding API . bidders . endpoints

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a bidder endpoint by its name.

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

Lists all the bidder's endpoints.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a bidder's endpoint.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets a bidder endpoint by its name.

Args:
  name: string, Required. Name of the bidder endpoint to get. Format: `bidders/{bidderAccountId}/endpoints/{endpointId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Bidder endpoint that receives bid requests.
  "bidProtocol": "A String", # The protocol that the bidder endpoint is using.
  "maximumQps": "A String", # The maximum number of queries per second allowed to be sent to this server.
  "name": "A String", # Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
  "tradingLocation": "A String", # The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
  "url": "A String", # Output only. The URL that bid requests should be sent to.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the bidder's endpoints.

Args:
  parent: string, Required. Name of the bidder whose endpoints will be listed. Format: `bidders/{bidderAccountId}` (required)
  pageSize: integer, The maximum number of endpoints to return. If unspecified, at most 100 endpoints will be returned. The maximum value is 500; values above 500 will be coerced to 500.
  pageToken: string, A token identifying a page of results the server should return. This value is received from a previous `ListEndpoints` call in ListEndpointsResponse.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 bidder endpoints.
  "endpoints": [ # List of bidder endpoints.
    { # Bidder endpoint that receives bid requests.
      "bidProtocol": "A String", # The protocol that the bidder endpoint is using.
      "maximumQps": "A String", # The maximum number of queries per second allowed to be sent to this server.
      "name": "A String", # Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
      "tradingLocation": "A String", # The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
      "url": "A String", # Output only. The URL that bid requests should be sent to.
    },
  ],
  "nextPageToken": "A String", # A token which can be passed to a subsequent call to the `ListEndpoints` method to retrieve the next page of results in ListEndpointsRequest.pageToken.
}
list_next()
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.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a bidder's endpoint.

Args:
  name: string, Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server. (required)
  body: object, The request body.
    The object takes the form of:

{ # Bidder endpoint that receives bid requests.
  "bidProtocol": "A String", # The protocol that the bidder endpoint is using.
  "maximumQps": "A String", # The maximum number of queries per second allowed to be sent to this server.
  "name": "A String", # Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
  "tradingLocation": "A String", # The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
  "url": "A String", # Output only. The URL that bid requests should be sent to.
}

  updateMask: string, Field mask to use for partial in-place updates.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Bidder endpoint that receives bid requests.
  "bidProtocol": "A String", # The protocol that the bidder endpoint is using.
  "maximumQps": "A String", # The maximum number of queries per second allowed to be sent to this server.
  "name": "A String", # Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
  "tradingLocation": "A String", # The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
  "url": "A String", # Output only. The URL that bid requests should be sent to.
}