2023-12-07
▼ ▲ adexchangebuyer2.buyers.filterSets.create
Path: v2beta1/{+ownerName}/filterSets
Flat Path: v2beta1/buyers/{buyersId}/filterSets
HTTP Method: POST
Parameters:
ownerName
Description: Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
isTransient
Description: Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
Location: query
Type: boolean
Parameter Order: ownerName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: Creates the specified filter set for the account with the given account ID.
▼ ▲ adexchangebuyer2.buyers.filterSets.get
Path: v2beta1/{+name}
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}
HTTP Method: GET
Parameters:
name
Description: Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: Retrieves the requested filter set for the account with the given account ID.
▼ ▲ adexchangebuyer2.buyers.filterSets.list
Path: v2beta1/{+ownerName}/filterSets
Flat Path: v2beta1/buyers/{buyersId}/filterSets
HTTP Method: GET
Parameters:
ownerName
Description: Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
Location: query
Type: string
Parameter Order: ownerName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: Lists all filter sets for the account with the given account ID.
▼ ▲ adexchangebuyer2.buyers.filterSets.delete
Path: v2beta1/{+name}
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}
HTTP Method: DELETE
Parameters:
name
Description: Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: Deletes the requested filter set from the account with the given account ID.
▼ ▲ adexchangebuyer2.buyers.filterSets.impressionMetrics.list
Path: v2beta1/{+filterSetName}/impressionMetrics
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/impressionMetrics
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: Lists all metrics that are measured in terms of number of impressions.
▼ ▲ adexchangebuyer2.buyers.filterSets.bidMetrics.list
Path: v2beta1/{+filterSetName}/bidMetrics
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidMetrics
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: Lists all metrics that are measured in terms of number of bids.
▼ ▲ adexchangebuyer2.buyers.filterSets.filteredBidRequests.list
Path: v2beta1/{+filterSetName}/filteredBidRequests
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBidRequests
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
▼ ▲ adexchangebuyer2.buyers.filterSets.bidResponseErrors.list
Path: v2beta1/{+filterSetName}/bidResponseErrors
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponseErrors
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
▼ ▲ adexchangebuyer2.buyers.filterSets.bidResponsesWithoutBids.list
Path: v2beta1/{+filterSetName}/bidResponsesWithoutBids
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
▼ ▲ adexchangebuyer2.buyers.filterSets.filteredBids.list
Path: v2beta1/{+filterSetName}/filteredBids
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all reasons for which bids were filtered, with the number of bids filtered for each reason.
▼ ▲ adexchangebuyer2.buyers.filterSets.filteredBids.details.list
Path: v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
creativeStatusId
Description: The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
Location: path
Required: Yes
Type: integer
Format: int32
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.
Location: query
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
▼ ▲ adexchangebuyer2.buyers.filterSets.filteredBids.creatives.list
Path: v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
creativeStatusId
Description: The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
Location: path
Required: Yes
Type: integer
Format: int32
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.
Location: query
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
▼ ▲ adexchangebuyer2.buyers.filterSets.losingBids.list
Path: v2beta1/{+filterSetName}/losingBids
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/losingBids
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
▼ ▲ adexchangebuyer2.buyers.filterSets.nonBillableWinningBids.list
Path: v2beta1/{+filterSetName}/nonBillableWinningBids
Flat Path: v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/nonBillableWinningBids
HTTP Method: GET
Parameters:
filterSetName
Description: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
Pattern: ^buyers/[^/]+/filterSets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.
Location: query
Type: string
Parameter Order: filterSetName
Scopes: https://www.googleapis.com/auth/adexchange.buyer
Description: List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.