Authorized Buyers Marketplace API . buyers . auctionPackages

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets an auction package given its name.

Args:
  name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
  "createTime": "A String", # Output only. Time the auction package was created.
  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
  "description": "A String", # Output only. A description of the auction package.
  "displayName": "A String", # The display_name assigned to the auction package.
  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
    "A String",
  ],
  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
    "A String",
  ],
  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
    "A String",
  ],
  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
    { # Describes a single Media Planner account.
      "accountId": "A String", # Output only. Account ID of the media planner.
    },
  ],
  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
}

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

List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

Args:
  parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
  filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
  orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
  pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
  pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for listing auction packages.
  "auctionPackages": [ # The list of auction packages.
    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
      "createTime": "A String", # Output only. Time the auction package was created.
      "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
      "description": "A String", # Output only. A description of the auction package.
      "displayName": "A String", # The display_name assigned to the auction package.
      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
        "A String",
      ],
      "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
      "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
        "A String",
      ],
      "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
        "A String",
      ],
      "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
        { # Describes a single Media Planner account.
          "accountId": "A String", # Output only. Account ID of the media planner.
        },
      ],
      "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
    },
  ],
  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
}

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.
        

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

Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.

Args:
  name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SubscribeAuctionPackage.
}

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

Returns:
  An object of the form:

    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
  "createTime": "A String", # Output only. Time the auction package was created.
  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
  "description": "A String", # Output only. A description of the auction package.
  "displayName": "A String", # The display_name assigned to the auction package.
  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
    "A String",
  ],
  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
    "A String",
  ],
  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
    "A String",
  ],
  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
    { # Describes a single Media Planner account.
      "accountId": "A String", # Output only. Account ID of the media planner.
    },
  ],
  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
}

subscribeClients(auctionPackage, body=None, x__xgafv=None)

Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.

Args:
  auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SubscribeAuctionPackageClients.
  "clients": [ # Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.
    "A String",
  ],
}

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

Returns:
  An object of the form:

    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
  "createTime": "A String", # Output only. Time the auction package was created.
  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
  "description": "A String", # Output only. A description of the auction package.
  "displayName": "A String", # The display_name assigned to the auction package.
  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
    "A String",
  ],
  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
    "A String",
  ],
  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
    "A String",
  ],
  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
    { # Describes a single Media Planner account.
      "accountId": "A String", # Output only. Account ID of the media planner.
    },
  ],
  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
}

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

Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.

Args:
  name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for UnsubscribeAuctionPackage.
}

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

Returns:
  An object of the form:

    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
  "createTime": "A String", # Output only. Time the auction package was created.
  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
  "description": "A String", # Output only. A description of the auction package.
  "displayName": "A String", # The display_name assigned to the auction package.
  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
    "A String",
  ],
  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
    "A String",
  ],
  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
    "A String",
  ],
  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
    { # Describes a single Media Planner account.
      "accountId": "A String", # Output only. Account ID of the media planner.
    },
  ],
  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
}

unsubscribeClients(auctionPackage, body=None, x__xgafv=None)

Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.

Args:
  auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for UnsubscribeAuctionPackage.
  "clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
    "A String",
  ],
}

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

Returns:
  An object of the form:

    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
  "createTime": "A String", # Output only. Time the auction package was created.
  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
  "description": "A String", # Output only. A description of the auction package.
  "displayName": "A String", # The display_name assigned to the auction package.
  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
    "A String",
  ],
  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
    "A String",
  ],
  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
    "A String",
  ],
  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
    { # Describes a single Media Planner account.
      "accountId": "A String", # Output only. Account ID of the media planner.
    },
  ],
  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
}