Real-time Bidding API (realtimebidding:v1)

2022-05-04

4 new methods

Additions

    Methods
  • realtimebidding.bidders.publisherConnections.batchReject

      Path: v1/{+parent}/publisherConnections:batchReject

      Parameters:

        parent

          Required: Yes

          Description: Required. The bidder for whom publisher connections will be rejected. Format: `bidders/{bidder}` where `{bidder}` is the account ID of the bidder.

          Location: path

          Type: string

          Pattern: ^bidders/[^/]+$

      Parameter Order: parent

      HTTP Method: POST

      Flat Path: v1/bidders/{biddersId}/publisherConnections:batchReject

      Description: Batch rejects multiple publisher connections.

      Scopes: https://www.googleapis.com/auth/realtime-bidding

  • realtimebidding.bidders.publisherConnections.get

      Scopes: https://www.googleapis.com/auth/realtime-bidding

      Parameters:

        name

          Description: Required. Name of the publisher whose connection information is to be retrieved. In the pattern `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt publisher ID. See publisherConnection.name.

          Required: Yes

          Type: string

          Location: path

          Pattern: ^bidders/[^/]+/publisherConnections/[^/]+$

      Flat Path: v1/bidders/{biddersId}/publisherConnections/{publisherConnectionsId}

      HTTP Method: GET

      Parameter Order: name

      Path: v1/{+name}

      Description: Gets a publisher connection.

  • realtimebidding.bidders.publisherConnections.list

      Flat Path: v1/bidders/{biddersId}/publisherConnections

      Description: Lists publisher connections for a given bidder.

      Parameters:

        pageSize

          Format: int32

          Type: integer

          Location: query

          Description: Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available via another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive.

        pageToken

          Type: string

          Location: query

          Description: A token identifying a page of results the server should return. Typically, this is the value of ListPublisherConnectionsResponse.nextPageToken returned from the previous call to the 'ListPublisherConnections' method.

        filter

          Type: string

          Description: Query string to filter publisher connections. Connections can be filtered by `displayName`, `publisherPlatform`, and `biddingState`. If no filter is specified, all publisher connections will be returned. Example: 'displayName="Great Publisher*" AND publisherPlatform=ADMOB AND biddingState != PENDING' See https://google.aip.dev/160 for more information about filtering syntax.

          Location: query

        orderBy

          Type: string

          Location: query

          Description: Order specification by which results should be sorted. If no sort order is specified, the results will be returned in an arbitrary order. Currently results can be sorted by `createTime`. Example: 'createTime DESC'.

        parent

          Location: path

          Description: Required. Name of the bidder for which publishers have initiated connections. The pattern for this resource is `bidders/{bidder}` where `{bidder}` represents the account ID of the bidder.

          Type: string

          Required: Yes

          Pattern: ^bidders/[^/]+$

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/realtime-bidding

      Parameter Order: parent

      Path: v1/{+parent}/publisherConnections

  • realtimebidding.bidders.publisherConnections.batchApprove

      Scopes: https://www.googleapis.com/auth/realtime-bidding

      HTTP Method: POST

      Path: v1/{+parent}/publisherConnections:batchApprove

      Parameter Order: parent

      Description: Batch approves multiple publisher connections.

      Flat Path: v1/bidders/{biddersId}/publisherConnections:batchApprove

      Parameters:

        parent

          Type: string

          Pattern: ^bidders/[^/]+$

          Required: Yes

          Description: Required. The bidder for whom publisher connections will be approved. Format: `bidders/{bidder}` where `{bidder}` is the account ID of the bidder.

          Location: path