Gcp/realtimebidding
@swamp/gcp/realtimebiddingv2026.09.15.1
01README
Google Cloud realtimebidding infrastructure models
02Release Notes
- Updated: buyers_creatives
03Models
@swamp/gcp/realtimebidding/biddersv2026.08.12.2bidders.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a bidders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bidders |
fn sync(identifier?: string)
Sync bidders state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific bidders by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List bidders resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of bidders to return. If unspecified, at most 100 bidders will be returned. The maximum value is 500; values above 500 will be coerced to 500. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Bidder settings.
@swamp/gcp/realtimebidding/bidders-creativesv2026.08.12.2bidders_creatives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
fn sync(identifier?: string)
Sync creatives state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific creatives by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, view?: string, maxPages?: number)
List creatives resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED' |
| pageSize? | number | Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. |
| view? | string | Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL". |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn watch()
watch
Resources
state(infinite)— A creative and its classification data.
@swamp/gcp/realtimebidding/bidders-endpointsv2026.08.12.2bidders_endpoints.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| bidProtocol? | enum | The protocol that the bidder endpoint is using. |
| maximumQps? | string | The maximum number of queries per second allowed to be sent to this server. |
| 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. |
| tradingLocation? | enum | 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? | string | Output only. The URL that bid requests should be sent to. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a endpoints
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the endpoints |
fn update(identifier?: string)
Update endpoints attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific endpoints by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync endpoints state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific endpoints by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List endpoints resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Bidder endpoint that receives bid requests.
@swamp/gcp/realtimebidding/bidders-pretargetingconfigsv2026.08.12.2bidders_pretargetingconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| appTargeting? | object | Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension). |
| displayName? | string | The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has. |
| excludedContentLabelIds? | array | The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. |
| geoTargeting? | object | The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv |
| includedCreativeDimensions? | array | Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. |
| includedEnvironments? | array | Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. |
| includedFormats? | array | Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. |
| includedLanguages? | array | The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| includedMobileOperatingSystemIds? | array | The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv |
| includedPlatforms? | array | The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. |
| includedUserIdTypes? | array | User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent. |
| interstitialTargeting? | enum | The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. |
| maximumQps? | string | The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide |
| minimumViewabilityDecile? | number | The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. |
| publisherTargeting? | object | Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.pub |
| userListTargeting? | object | The remarketing lists included or excluded in this config as defined in UserList. |
| verticalTargeting? | object | The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals |
| webTargeting? | object | Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config). |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a pretargetingConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a pretargetingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the pretargetingConfigs |
fn update(identifier?: string, waitForReady?: boolean)
Update pretargetingConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific pretargetingConfigs by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the pretargetingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the pretargetingConfigs |
fn sync(identifier?: string)
Sync pretargetingConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific pretargetingConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List pretargetingConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn activate()
activate
fn add_targeted_apps(appIds?: any, targetingMode?: any)
add targeted apps
| Argument | Type | Description |
|---|---|---|
| appIds? | any | |
| targetingMode? | any |
fn add_targeted_publishers(publisherIds?: any, targetingMode?: any)
add targeted publishers
| Argument | Type | Description |
|---|---|---|
| publisherIds? | any | |
| targetingMode? | any |
fn add_targeted_sites(sites?: any, targetingMode?: any)
add targeted sites
| Argument | Type | Description |
|---|---|---|
| sites? | any | |
| targetingMode? | any |
fn suspend()
suspend
Resources
state(infinite)— Pretargeting config: a set of targeting dimensions applied at the pretargetin...
@swamp/gcp/realtimebidding/bidders-publisherconnectionsv2026.08.12.2bidders_publisherconnections.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a publisherConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the publisherConnections |
fn sync(identifier?: string)
Sync publisherConnections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific publisherConnections by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List publisherConnections resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | 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=\ |
| orderBy? | string | Order specification by which results should be sorted. If no sort order is specified, the results will be returned in alphabetic order based on the publisher's publisher code. Results can be sorted by `createTime`. Example: 'createTime DESC'. |
| pageSize? | number | Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available through another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_approve(names?: any)
batch approve
| Argument | Type | Description |
|---|---|---|
| names? | any |
fn batch_reject(names?: any)
batch reject
| Argument | Type | Description |
|---|---|---|
| names? | any |
Resources
state(infinite)— An Open Bidding exchange's connection to a publisher. This is initiated by th...
@swamp/gcp/realtimebidding/buyersv2026.08.12.2buyers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a buyers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the buyers |
fn sync(identifier?: string)
Sync buyers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific buyers by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List buyers resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of buyers to return. If unspecified, at most 100 buyers will be returned. The maximum value is 500; values above 500 will be coerced to 500. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_remarketing_tag()
get remarketing tag
Resources
state(infinite)— RTB Buyer account information.
@swamp/gcp/realtimebidding/buyers-creativesv2026.09.15.1buyers_creatives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| adChoicesDestinationUrl? | string | The link to AdChoices destination page. This is only supported for native ads. |
| advertiserName? | string | The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. |
| agencyId? | string | The agency ID for this creative. |
| creativeId? | string | Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. |
| declaredAttributes? | array | All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto") contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. |
| declaredClickThroughUrls? | array | The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method. |
| declaredVendorIds? | array | IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. |
| html? | object | An HTML creative. |
| impressionTrackingUrls? | array | The set of URLs to be called to record an impression. |
| native? | object | A native creative. |
| video? | object | A video creative. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a creatives
fn get(identifier: string)
Get a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
fn update(identifier?: string)
Update creatives attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific creatives by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync creatives state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific creatives by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, view?: string, maxPages?: number)
List creatives resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED' |
| pageSize? | number | Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. |
| view? | string | Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL". |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_deals(dealIds?: any)
add deals
| Argument | Type | Description |
|---|---|---|
| dealIds? | any |
Resources
state(infinite)— A creative and its classification data.
@swamp/gcp/realtimebidding/buyers-userlistsv2026.08.12.2buyers_userlists.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| description? | string | The description for the user list. |
| displayName? | string | Required. Display name of the user list. This must be unique across all user lists for a given account. |
| membershipDurationDays? | string | Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive. |
| urlRestriction? | object | Required. Deprecated. This will be removed in October 2023. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api The URL restriction for the user list. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a userLists
fn get(identifier: string)
Get a userLists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userLists |
fn update(identifier?: string)
Update userLists attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userLists by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync userLists state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userLists by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List userLists resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The number of results to return per page. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn close()
close
fn get_remarketing_tag()
get remarketing tag
fn open()
open
Resources
state(infinite)— Represents an Authorized Buyers user list. Authorized Buyers can create/updat...
04Previous Versions
2026.08.12.2
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.07.29.1
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.07.21.4
- Updated: bidders_pretargetingconfigs, buyers_creatives
2026.07.21.1
- Updated: bidders_pretargetingconfigs, buyers_creatives, buyers_userlists
2026.07.20.2
- Updated: bidders_pretargetingconfigs, buyers_creatives
2026.07.20.1
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.07.19.1
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.07.18.1
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.07.17.2
- Updated: bidders_endpoints, bidders_pretargetingconfigs, buyers_creatives
2026.07.17.1
- Updated: bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers_creatives, buyers_userlists
2026.06.08.2
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.06.07.1
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.05.26.1
- Updated: buyers_creatives
2026.05.25.2
- Updated: bidders, buyers
Modified 8 models
2026.05.24.1
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.05.21.2
- Updated: bidders, bidders_creatives, bidders_endpoints, bidders_pretargetingconfigs, bidders_publisherconnections, buyers, buyers_creatives, buyers_userlists
2026.05.21.1
2026.05.20.1
- Updated: buyers_creatives
2026.05.19.2
05Stats
A
100 / 100
Downloads
0
Archive size
105.6 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels