@swamp/gcp/adexchangebuyer2
v2026.04.23.1
Google Cloud adexchangebuyer2 infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudadexchangebuyer2cloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/adexchangebuyer2@swamp/gcp/adexchangebuyer2/accounts-clientsv2026.04.23.1accounts_clients.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| clientAccountId? | string | The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations. |
| clientName? | string | Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed. |
| entityId? | string | Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://st |
| entityName? | string | The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations. |
| entityType? | enum | An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`. |
| partnerClientId? | string | Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer. |
| role? | enum | The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. |
| status? | enum | The status of the client buyer. |
| visibleToSeller? | boolean | Whether the client buyer will be visible to sellers. |
| accountId | string | Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) |
createCreate a clients
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a clients
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the clients |
updateUpdate clients attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
syncSync clients state from GCP
Resources
state(infinite)— A client resource represents a client buyer—an agency, a brand, or an adverti...
@swamp/gcp/adexchangebuyer2/accounts-clients-invitationsv2026.04.23.1accounts_clients_invitations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| clientAccountId? | string | Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations. |
| email? | string | The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer. |
| invitationId? | string | The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations. |
| accountId | string | Numerical account ID of the client's sponsor buyer. (required) |
createCreate a invitations
getGet a invitations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the invitations |
syncSync invitations state from GCP
Resources
state(infinite)— An invitation for a new client user to get access to the Authorized Buyers UI...
@swamp/gcp/adexchangebuyer2/accounts-clients-usersv2026.04.23.1accounts_clients_users.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| clientAccountId? | string | Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. |
| email? | string | User's email address. The value of this field is ignored in an update operation. |
| status? | enum | The status of the client user. |
| userId? | string | The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. |
getGet a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
updateUpdate users attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
syncSync users state from GCP
Resources
state(infinite)— A client user is created under a client buyer and has restricted access to th...
@swamp/gcp/adexchangebuyer2/accounts-creativesv2026.04.23.1accounts_creatives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accountId? | string | The account that this creative belongs to. Can be used to filter the response of the creatives.list method. |
| adChoicesDestinationUrl? | string | The link to AdChoices destination page. |
| adTechnologyProviders? | object | Detected ad technology provider information. |
| advertiserName? | string | The name of the company being advertised in the creative. |
| agencyId? | string | The agency ID for this creative. |
| attributes? | array | All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. |
| clickThroughUrls? | array | The set of destination URLs for the creative. |
| creativeId? | string | The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. |
| declaredClickThroughUrls? | array | The set of declared destination URLs for the creative. |
| html? | object | HTML content for a creative. |
| impressionTrackingUrls? | array | The set of URLs to be called to record an impression. |
| native? | object | Native content for a creative. |
| restrictedCategories? | array | All restricted categories for the ads that may be shown from this creative. |
| vendorIds? | array | All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. |
| video? | object | Video content for a creative. |
| duplicateIdMode? | string | Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). |
createCreate a creatives
getGet a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
updateUpdate creatives attributes
syncSync creatives state from GCP
stop_watchingstop watching
watchwatch
| Argument | Type | Description |
|---|---|---|
| topic? | any |
Resources
state(infinite)— A creative and its classification data.
@swamp/gcp/adexchangebuyer2/accounts-creatives-dealassociationsv2026.04.23.1accounts_creatives_dealassociations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a dealAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dealAssociations |
deleteDelete the dealAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dealAssociations |
syncSync dealAssociations state from GCP
addadd
| Argument | Type | Description |
|---|---|---|
| association? | any |
Resources
state(infinite)— The association between a creative and a deal.
@swamp/gcp/adexchangebuyer2/accounts-finalizedproposalsv2026.04.23.1accounts_finalizedproposals.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a finalizedProposals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the finalizedProposals |
syncSync finalizedProposals state from GCP
pausepause
| Argument | Type | Description |
|---|---|---|
| externalDealIds? | any | |
| reason? | any |
resumeresume
| Argument | Type | Description |
|---|---|---|
| externalDealIds? | any |
Resources
state(infinite)— Represents a proposal in the Marketplace. A proposal is the unit of negotiati...
@swamp/gcp/adexchangebuyer2/accounts-productsv2026.04.23.1accounts_products.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
syncSync products state from GCP
Resources
state(infinite)— A product is a segment of inventory that a seller wants to sell. It is associ...
@swamp/gcp/adexchangebuyer2/accounts-proposalsv2026.04.23.1accounts_proposals.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| billedBuyer? | object | Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. |
| buyer? | object | Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. |
| buyerContacts? | array | Contact information for the buyer. |
| buyerPrivateData? | object | Buyers are allowed to store certain types of private data in a proposal/deal. |
| deals? | array | The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| displayName? | string | The name for the proposal. |
| seller? | object | Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. |
| accountId | string | Account ID of the buyer. |
createCreate a proposals
getGet a proposals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the proposals |
updateUpdate proposals attributes
syncSync proposals state from GCP
acceptaccept
| Argument | Type | Description |
|---|---|---|
| proposalRevision? | any |
add_noteadd note
| Argument | Type | Description |
|---|---|---|
| note? | any |
cancel_negotiationcancel negotiation
complete_setupcomplete setup
pausepause
| Argument | Type | Description |
|---|---|---|
| reason? | any |
resumeresume
Resources
state(infinite)— Represents a proposal in the Marketplace. A proposal is the unit of negotiati...
@swamp/gcp/adexchangebuyer2/accounts-publisherprofilesv2026.04.23.1accounts_publisherprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a publisherProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the publisherProfiles |
syncSync publisherProfiles state from GCP
Resources
state(infinite)— Represents a publisher profile (https://support.google.com/admanager/answer/6...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersetsv2026.04.23.1bidders_accounts_filtersets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| absoluteDateRange? | object | An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. |
| breakdownDimensions? | array | The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. |
| creativeId? | string | The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. |
| dealId? | string | The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. |
| environment? | enum | The environment on which to filter; optional. |
| format? | enum | Creative format bidded on or allowed to bid on, can be empty. |
| name? | string | A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. |
| platforms? | array | The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). |
| publisherIdentifiers? | array | For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. |
| realtimeTimeRange? | object | An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. |
| relativeDateRange? | object | A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 |
| sellerNetworkIds? | array | For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. |
| timeSeriesGranularity? | enum | The granularity of time intervals if a time series breakdown is preferred; optional. |
| ownerName | string | 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` |
| isTransient? | string | 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. |
createCreate a filterSets
getGet a filterSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filterSets |
deleteDelete the filterSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filterSets |
syncSync filterSets state from GCP
Resources
state(infinite)— A set of filters that is applied to a request for data. Within a filter set, ...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-bidmetricsv2026.04.23.1bidders_accounts_filtersets_bidmetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidMetrics |
syncSync bidMetrics state from GCP
Resources
state(infinite)— The set of metrics that are measured in numbers of bids, representing how man...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-bidresponseerrorsv2026.04.23.1bidders_accounts_filtersets_bidresponseerrors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidResponseErrors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidResponseErrors |
syncSync bidResponseErrors state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values where the corre...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-bidresponseswithoutbidsv2026.04.23.1bidders_accounts_filtersets_bidresponseswithoutbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidResponsesWithoutBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidResponsesWithoutBids |
syncSync bidResponsesWithoutBids state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values that were consi...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-filteredbidrequestsv2026.04.23.1bidders_accounts_filtersets_filteredbidrequests.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a filteredBidRequests
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filteredBidRequests |
syncSync filteredBidRequests state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values where the corre...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-filteredbidsv2026.04.23.1bidders_accounts_filtersets_filteredbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a filteredBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filteredBids |
syncSync filteredBids state from GCP
Resources
state(infinite)— The number of bids with the specified dimension values that did not win the a...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-filteredbids-creativesv2026.04.23.1bidders_accounts_filtersets_filteredbids_creatives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
syncSync creatives state from GCP
Resources
state(infinite)— The number of filtered bids with the specified dimension values that have the...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-filteredbids-detailsv2026.04.23.1bidders_accounts_filtersets_filteredbids_details.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a details
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the details |
syncSync details state from GCP
Resources
state(infinite)— The number of filtered bids with the specified dimension values, among those ...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-impressionmetricsv2026.04.23.1bidders_accounts_filtersets_impressionmetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a impressionMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the impressionMetrics |
syncSync impressionMetrics state from GCP
Resources
state(infinite)— The set of metrics that are measured in numbers of impressions, representing ...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-losingbidsv2026.04.23.1bidders_accounts_filtersets_losingbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a losingBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the losingBids |
syncSync losingBids state from GCP
Resources
state(infinite)— The number of bids with the specified dimension values that did not win the a...
@swamp/gcp/adexchangebuyer2/bidders-accounts-filtersets-nonbillablewinningbidsv2026.04.23.1bidders_accounts_filtersets_nonbillablewinningbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a nonBillableWinningBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nonBillableWinningBids |
syncSync nonBillableWinningBids state from GCP
Resources
state(infinite)— The number of winning bids with the specified dimension values for which the ...
@swamp/gcp/adexchangebuyer2/bidders-filtersetsv2026.04.23.1bidders_filtersets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| absoluteDateRange? | object | An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. |
| breakdownDimensions? | array | The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. |
| creativeId? | string | The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. |
| dealId? | string | The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. |
| environment? | enum | The environment on which to filter; optional. |
| format? | enum | Creative format bidded on or allowed to bid on, can be empty. |
| name? | string | A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. |
| platforms? | array | The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). |
| publisherIdentifiers? | array | For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. |
| realtimeTimeRange? | object | An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. |
| relativeDateRange? | object | A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 |
| sellerNetworkIds? | array | For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. |
| timeSeriesGranularity? | enum | The granularity of time intervals if a time series breakdown is preferred; optional. |
| ownerName | string | 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` |
| isTransient? | string | 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. |
createCreate a filterSets
getGet a filterSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filterSets |
deleteDelete the filterSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filterSets |
syncSync filterSets state from GCP
Resources
state(infinite)— A set of filters that is applied to a request for data. Within a filter set, ...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-bidmetricsv2026.04.23.1bidders_filtersets_bidmetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidMetrics |
syncSync bidMetrics state from GCP
Resources
state(infinite)— The set of metrics that are measured in numbers of bids, representing how man...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-bidresponseerrorsv2026.04.23.1bidders_filtersets_bidresponseerrors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidResponseErrors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidResponseErrors |
syncSync bidResponseErrors state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values where the corre...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-bidresponseswithoutbidsv2026.04.23.1bidders_filtersets_bidresponseswithoutbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidResponsesWithoutBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidResponsesWithoutBids |
syncSync bidResponsesWithoutBids state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values that were consi...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-filteredbidrequestsv2026.04.23.1bidders_filtersets_filteredbidrequests.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a filteredBidRequests
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filteredBidRequests |
syncSync filteredBidRequests state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values where the corre...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-filteredbidsv2026.04.23.1bidders_filtersets_filteredbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a filteredBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filteredBids |
syncSync filteredBids state from GCP
Resources
state(infinite)— The number of bids with the specified dimension values that did not win the a...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-filteredbids-creativesv2026.04.23.1bidders_filtersets_filteredbids_creatives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
syncSync creatives state from GCP
Resources
state(infinite)— The number of filtered bids with the specified dimension values that have the...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-filteredbids-detailsv2026.04.23.1bidders_filtersets_filteredbids_details.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a details
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the details |
syncSync details state from GCP
Resources
state(infinite)— The number of filtered bids with the specified dimension values, among those ...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-impressionmetricsv2026.04.23.1bidders_filtersets_impressionmetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a impressionMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the impressionMetrics |
syncSync impressionMetrics state from GCP
Resources
state(infinite)— The set of metrics that are measured in numbers of impressions, representing ...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-losingbidsv2026.04.23.1bidders_filtersets_losingbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a losingBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the losingBids |
syncSync losingBids state from GCP
Resources
state(infinite)— The number of bids with the specified dimension values that did not win the a...
@swamp/gcp/adexchangebuyer2/bidders-filtersets-nonbillablewinningbidsv2026.04.23.1bidders_filtersets_nonbillablewinningbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a nonBillableWinningBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nonBillableWinningBids |
syncSync nonBillableWinningBids state from GCP
Resources
state(infinite)— The number of winning bids with the specified dimension values for which the ...
@swamp/gcp/adexchangebuyer2/buyers-filtersetsv2026.04.23.1buyers_filtersets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| absoluteDateRange? | object | An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. |
| breakdownDimensions? | array | The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions. |
| creativeId? | string | The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. |
| dealId? | string | The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. |
| environment? | enum | The environment on which to filter; optional. |
| format? | enum | Creative format bidded on or allowed to bid on, can be empty. |
| name? | string | A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations. |
| platforms? | array | The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). |
| publisherIdentifiers? | array | For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together. |
| realtimeTimeRange? | object | An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. |
| relativeDateRange? | object | A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, for example, the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 |
| sellerNetworkIds? | array | For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. |
| timeSeriesGranularity? | enum | The granularity of time intervals if a time series breakdown is preferred; optional. |
| ownerName | string | 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` |
| isTransient? | string | 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. |
createCreate a filterSets
getGet a filterSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filterSets |
deleteDelete the filterSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filterSets |
syncSync filterSets state from GCP
Resources
state(infinite)— A set of filters that is applied to a request for data. Within a filter set, ...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-bidmetricsv2026.04.23.1buyers_filtersets_bidmetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidMetrics |
syncSync bidMetrics state from GCP
Resources
state(infinite)— The set of metrics that are measured in numbers of bids, representing how man...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-bidresponseerrorsv2026.04.23.1buyers_filtersets_bidresponseerrors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidResponseErrors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidResponseErrors |
syncSync bidResponseErrors state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values where the corre...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-bidresponseswithoutbidsv2026.04.23.1buyers_filtersets_bidresponseswithoutbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a bidResponsesWithoutBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidResponsesWithoutBids |
syncSync bidResponsesWithoutBids state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values that were consi...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-filteredbidrequestsv2026.04.23.1buyers_filtersets_filteredbidrequests.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a filteredBidRequests
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filteredBidRequests |
syncSync filteredBidRequests state from GCP
Resources
state(infinite)— The number of impressions with the specified dimension values where the corre...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-filteredbidsv2026.04.23.1buyers_filtersets_filteredbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a filteredBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filteredBids |
syncSync filteredBids state from GCP
Resources
state(infinite)— The number of bids with the specified dimension values that did not win the a...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-filteredbids-creativesv2026.04.23.1buyers_filtersets_filteredbids_creatives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
syncSync creatives state from GCP
Resources
state(infinite)— The number of filtered bids with the specified dimension values that have the...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-filteredbids-detailsv2026.04.23.1buyers_filtersets_filteredbids_details.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a details
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the details |
syncSync details state from GCP
Resources
state(infinite)— The number of filtered bids with the specified dimension values, among those ...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-impressionmetricsv2026.04.23.1buyers_filtersets_impressionmetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a impressionMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the impressionMetrics |
syncSync impressionMetrics state from GCP
Resources
state(infinite)— The set of metrics that are measured in numbers of impressions, representing ...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-losingbidsv2026.04.23.1buyers_filtersets_losingbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a losingBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the losingBids |
syncSync losingBids state from GCP
Resources
state(infinite)— The number of bids with the specified dimension values that did not win the a...
@swamp/gcp/adexchangebuyer2/buyers-filtersets-nonbillablewinningbidsv2026.04.23.1buyers_filtersets_nonbillablewinningbids.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a nonBillableWinningBids
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the nonBillableWinningBids |
syncSync nonBillableWinningBids state from GCP
Resources
state(infinite)— The number of winning bids with the specified dimension values for which the ...
2026.04.04.1100.9 KBApr 4, 2026
Google Cloud adexchangebuyer2 infrastructure models
Release Notes
- Updated: accounts_creatives, accounts_finalizedproposals, accounts_products, accounts_proposals
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudadexchangebuyer2cloudinfrastructure
2026.04.03.3114.2 KBApr 3, 2026
Google Cloud adexchangebuyer2 infrastructure models
Release Notes
- Updated: accounts_clients, accounts_clients_invitations, accounts_clients_users, accounts_creatives, accounts_creatives_dealassociations, accounts_finalizedproposals, accounts_products, accounts_proposals, accounts_publisherprofiles, bidders_accounts_filtersets, bidders_accounts_filtersets_bidmetrics, bidders_accounts_filtersets_bidresponseerrors, bidders_accounts_filtersets_bidresponseswithoutbids, bidders_accounts_filtersets_filteredbidrequests, bidders_accounts_filtersets_filteredbids, bidders_accounts_filtersets_filteredbids_creatives, bidders_accounts_filtersets_filteredbids_details, bidders_accounts_filtersets_impressionmetrics, bidders_accounts_filtersets_losingbids, bidders_accounts_filtersets_nonbillablewinningbids, bidders_filtersets, bidders_filtersets_bidmetrics, bidders_filtersets_bidresponseerrors, bidders_filtersets_bidresponseswithoutbids, bidders_filtersets_filteredbidrequests, bidders_filtersets_filteredbids, bidders_filtersets_filteredbids_creatives, bidders_filtersets_filteredbids_details, bidders_filtersets_impressionmetrics, bidders_filtersets_losingbids, bidders_filtersets_nonbillablewinningbids, buyers_filtersets, buyers_filtersets_bidmetrics, buyers_filtersets_bidresponseerrors, buyers_filtersets_bidresponseswithoutbids, buyers_filtersets_filteredbidrequests, buyers_filtersets_filteredbids, buyers_filtersets_filteredbids_creatives, buyers_filtersets_filteredbids_details, buyers_filtersets_impressionmetrics, buyers_filtersets_losingbids, buyers_filtersets_nonbillablewinningbids
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudadexchangebuyer2cloudinfrastructure
2026.04.03.1112.8 KBApr 3, 2026
Google Cloud adexchangebuyer2 infrastructure models
Release Notes
- Updated: accounts_clients, accounts_clients_invitations, accounts_clients_users, accounts_creatives, accounts_creatives_dealassociations, accounts_finalizedproposals, accounts_products, accounts_proposals, accounts_publisherprofiles, bidders_accounts_filtersets, bidders_accounts_filtersets_bidmetrics, bidders_accounts_filtersets_bidresponseerrors, bidders_accounts_filtersets_bidresponseswithoutbids, bidders_accounts_filtersets_filteredbidrequests, bidders_accounts_filtersets_filteredbids, bidders_accounts_filtersets_filteredbids_creatives, bidders_accounts_filtersets_filteredbids_details, bidders_accounts_filtersets_impressionmetrics, bidders_accounts_filtersets_losingbids, bidders_accounts_filtersets_nonbillablewinningbids, bidders_filtersets, bidders_filtersets_bidmetrics, bidders_filtersets_bidresponseerrors, bidders_filtersets_bidresponseswithoutbids, bidders_filtersets_filteredbidrequests, bidders_filtersets_filteredbids, bidders_filtersets_filteredbids_creatives, bidders_filtersets_filteredbids_details, bidders_filtersets_impressionmetrics, bidders_filtersets_losingbids, bidders_filtersets_nonbillablewinningbids, buyers_filtersets, buyers_filtersets_bidmetrics, buyers_filtersets_bidresponseerrors, buyers_filtersets_bidresponseswithoutbids, buyers_filtersets_filteredbidrequests, buyers_filtersets_filteredbids, buyers_filtersets_filteredbids_creatives, buyers_filtersets_filteredbids_details, buyers_filtersets_impressionmetrics, buyers_filtersets_losingbids, buyers_filtersets_nonbillablewinningbids
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudadexchangebuyer2cloudinfrastructure
2026.04.02.2112.6 KBApr 2, 2026
Google Cloud adexchangebuyer2 infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudadexchangebuyer2cloudinfrastructure
2026.03.27.1112.0 KBMar 27, 2026
Google Cloud adexchangebuyer2 infrastructure models
Release Notes
- Added: accounts_clients, accounts_clients_invitations, accounts_clients_users, accounts_creatives, accounts_creatives_dealassociations, accounts_finalizedproposals, accounts_products, accounts_proposals, accounts_publisherprofiles, bidders_accounts_filtersets, bidders_accounts_filtersets_bidmetrics, bidders_accounts_filtersets_bidresponseerrors, bidders_accounts_filtersets_bidresponseswithoutbids, bidders_accounts_filtersets_filteredbidrequests, bidders_accounts_filtersets_filteredbids, bidders_accounts_filtersets_filteredbids_creatives, bidders_accounts_filtersets_filteredbids_details, bidders_accounts_filtersets_impressionmetrics, bidders_accounts_filtersets_losingbids, bidders_accounts_filtersets_nonbillablewinningbids, bidders_filtersets, bidders_filtersets_bidmetrics, bidders_filtersets_bidresponseerrors, bidders_filtersets_bidresponseswithoutbids, bidders_filtersets_filteredbidrequests, bidders_filtersets_filteredbids, bidders_filtersets_filteredbids_creatives, bidders_filtersets_filteredbids_details, bidders_filtersets_impressionmetrics, bidders_filtersets_losingbids, bidders_filtersets_nonbillablewinningbids, buyers_filtersets, buyers_filtersets_bidmetrics, buyers_filtersets_bidresponseerrors, buyers_filtersets_bidresponseswithoutbids, buyers_filtersets_filteredbidrequests, buyers_filtersets_filteredbids, buyers_filtersets_filteredbids_creatives, buyers_filtersets_filteredbids_details, buyers_filtersets_impressionmetrics, buyers_filtersets_losingbids, buyers_filtersets_nonbillablewinningbids
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudadexchangebuyer2cloudinfrastructure