Gcp/dfareporting
@swamp/gcp/dfareportingv2026.06.09.1
01README
Google Cloud dfareporting infrastructure models
02Models
accountactiveadsummaries.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a accountActiveAdSummaries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accountActiveAdSummaries |
fn sync()
Sync accountActiveAdSummaries state from GCP
accountpermissiongroups.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a accountPermissionGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the accountPermissionGroups |
fn sync()
Sync accountPermissionGroups state from GCP
fn list(maxPages?: number)
List accountPermissionGroups resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
accountpermissions.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a accountPermissions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the accountPermissions |
fn sync()
Sync accountPermissions state from GCP
fn list(maxPages?: number)
List accountPermissions resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
accounts.tsv2026.06.08.1
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. |
| accountPermissionIds? | array | Account permissions assigned to this account. |
| accountProfile? | enum | Profile for this account. This is a read-only field that can be left blank. |
| active? | boolean | Whether this account is active. |
| activeAdsLimitTier? | enum | Maximum number of active ads allowed for this account. |
| activeViewOptOut? | boolean | Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. |
| availablePermissionIds? | array | User role permissions available to the user roles of this account. |
| countryId? | string | ID of the country associated with this account. |
| currencyId? | string | ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP |
| defaultCreativeSizeId? | string | Default placement dimensions for this account. |
| description? | string | Description of this account. |
| id? | string | ID of this account. This is a read-only, auto-generated field. |
| kind? | string | Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". |
| locale? | string | Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) |
| maximumImageSize? | string | Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. |
| name? | string | Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. |
| nielsenOcrEnabled? | boolean | Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. |
| reportsConfiguration? | object | Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. |
| shareReportsWithTwitter? | boolean | Share Path to Conversion reports with Twitter. |
| teaserSizeLimit? | string | File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. |
fn get(identifier: string)
Get a accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the accounts |
fn update()
Update accounts attributes
fn sync()
Sync accounts state from GCP
fn list(active?: boolean, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List accounts resources
| Argument | Type | Description |
|---|---|---|
| active? | boolean | Select only active accounts. Don't set this field to select both active and non-active accounts. |
| ids? | string | Select only accounts with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
accountuserprofiles.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of the user profile. This is a read-only field that can be left blank. |
| active? | boolean | Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. |
| advertiserFilter? | object | Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". |
| campaignFilter? | object | Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". |
| comments? | string | Comments for this user profile. |
| email? | string | Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion. |
| id? | string | ID of the user profile. This is a read-only, auto-generated field. |
| locale? | string | Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) |
| name? | string | Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,". |
| siteFilter? | object | Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". |
| subaccountId? | string | Subaccount ID of the user profile. This is a read-only field that can be left blank. |
| traffickerType? | enum | Trafficker type of this user profile. This is a read-only field. |
| userAccessType? | enum | User type of the user profile. This is a read-only field that can be left blank. |
| userRoleFilter? | object | Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". |
| userRoleId? | string | User role ID of the user profile. This is a required field. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a accountUserProfiles
fn get(identifier: string)
Get a accountUserProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the accountUserProfiles |
fn update()
Update accountUserProfiles attributes
fn sync()
Sync accountUserProfiles state from GCP
fn list(active?: boolean, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, subaccountId?: string, userRoleId?: string, maxPages?: number)
List accountUserProfiles resources
| Argument | Type | Description |
|---|---|---|
| active? | boolean | Select only active user profiles. |
| ids? | string | Select only user profiles with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| subaccountId? | string | Select only user profiles with the specified subaccount ID. |
| userRoleId? | string | Select only user profiles with the specified user role ID. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
ads.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this ad. This is a read-only field that can be left blank. |
| active? | boolean | Whether this ad is active. When true, archived must be false. |
| advertiserId? | string | Advertiser ID of this ad. This is a required field on insertion. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| archived? | boolean | Whether this ad is archived. When true, active must be false. |
| audienceSegmentId? | string | Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. |
| campaignId? | string | Campaign ID of this ad. This is a required field on insertion. |
| campaignIdDimensionValue? | object | The name of the dimension. |
| clickThroughUrl? | object | Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. |
| clickThroughUrlSuffixProperties? | object | Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. |
| comments? | string | Comments for this ad. |
| compatibility? | enum | Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. |
| contextualKeywordTargeting? | object | The keyword that can be targeted by ads. |
| createInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| creativeGroupAssignments? | array | ID of the creative group to be assigned. |
| creativeRotation? | object | Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. |
| dayPartTargeting? | object | Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" |
| defaultClickThroughEventTagProperties? | object | ID of the click-through event tag to apply to all ads in this entity's scope. |
| deliverySchedule? | object | Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. |
| dynamicClickTracker? | boolean | Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. |
| endTime? | string | |
| eventTagOverrides? | array | Whether this override is enabled. |
| geoTargeting? | object | Country code of the country to which this city belongs. |
| id? | string | ID of this ad. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| keyValueTargetingExpression? | object | Keyword expression being targeted by the ad. |
| languageTargeting? | object | Language ID of this language. This is the ID used for targeting and generating reports. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| name? | string | Name of this ad. This is a required field and must be less than 256 characters long. |
| placementAssignments? | array | Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. |
| remarketingListExpression? | object | Expression describing which lists are being targeted by the ad. |
| size? | object | Height of this size. Acceptable values are 0 to 32767, inclusive. |
| sslCompliant? | boolean | Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. |
| sslRequired? | boolean | Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. |
| startTime? | string | |
| subaccountId? | string | Subaccount ID of this ad. This is a read-only field that can be left blank. |
| targetingTemplateId? | string | Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. |
| technologyTargeting? | object | ID referring to this grouping of browser and version numbers. This is the ID used for targeting. |
| type? | enum | Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a ads
fn get(identifier: string)
Get a ads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the ads |
fn update()
Update ads attributes
fn sync()
Sync ads state from GCP
fn list(active?: boolean, advertiserId?: string, archived?: boolean, audienceSegmentIds?: string, campaignIds?: string, compatibility?: string, creativeIds?: string, creativeOptimizationConfigurationIds?: string, dynamicClickTracker?: boolean, ids?: string, landingPageIds?: string, maxResults?: number, overriddenEventTagId?: string, placementIds?: string, remarketingListIds?: string, searchString?: string, sizeIds?: string, sortField?: string, sortOrder?: string, sslCompliant?: boolean, sslRequired?: boolean, type?: string, maxPages?: number)
List ads resources
| Argument | Type | Description |
|---|---|---|
| active? | boolean | Select only active ads. |
| advertiserId? | string | Select only ads with this advertiser ID. |
| archived? | boolean | Select only archived ads. |
| audienceSegmentIds? | string | Select only ads with these audience segment IDs. |
| campaignIds? | string | Select only ads with these campaign IDs. |
| compatibility? | string | Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. |
| creativeIds? | string | Select only ads with these creative IDs assigned. |
| creativeOptimizationConfigurationIds? | string | Select only ads with these creative optimization configuration IDs. |
| dynamicClickTracker? | boolean | Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. |
| ids? | string | Select only ads with these IDs. |
| landingPageIds? | string | Select only ads with these landing page IDs. |
| maxResults? | number | Maximum number of results to return. |
| overriddenEventTagId? | string | Select only ads with this event tag override ID. |
| placementIds? | string | Select only ads with these placement IDs assigned. |
| remarketingListIds? | string | Select only ads whose list targeting expression use these remarketing list IDs. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". |
| sizeIds? | string | Select only ads with these size IDs. |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| sslCompliant? | boolean | Select only ads that are SSL-compliant. |
| sslRequired? | boolean | Select only ads that require SSL. |
| type? | string | Select only ads with these types. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisergroups.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this advertiser group. This is a read-only field that can be left blank. |
| id? | string | ID of this advertiser group. This is a read-only, auto-generated field. |
| name? | string | Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a advertiserGroups
fn get(identifier: string)
Get a advertiserGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the advertiserGroups |
fn update()
Update advertiserGroups attributes
fn delete(identifier: string)
Delete the advertiserGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the advertiserGroups |
fn sync()
Sync advertiserGroups state from GCP
fn list(ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List advertiserGroups resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Select only advertiser groups with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertiserinvoices.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a advertiserInvoices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the advertiserInvoices |
fn sync()
Sync advertiserInvoices state from GCP
fn list(issueMonth?: string, maxResults?: number, maxPages?: number)
List advertiserInvoices resources
| Argument | Type | Description |
|---|---|---|
| issueMonth? | string | Month for which invoices are needed in the format YYYYMM. Required field |
| maxResults? | number | Maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertiserlandingpages.tsv2026.06.08.1
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. |
| advertiserId? | string | Advertiser ID of this landing page. This is a required field. |
| archived? | boolean | Whether this landing page has been archived. |
| deepLinks? | array | The URL of the mobile app being linked to. |
| id? | string | ID of this landing page. This is a read-only, auto-generated field. |
| name? | string | Name of this landing page. This is a required field. It must be less than 256 characters long. |
| url? | string | URL of this landing page. This is a required field. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a advertiserLandingPages
fn get(identifier: string)
Get a advertiserLandingPages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the advertiserLandingPages |
fn update()
Update advertiserLandingPages attributes
fn sync()
Sync advertiserLandingPages state from GCP
fn list(advertiserIds?: string, archived?: boolean, campaignIds?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, subaccountId?: string, maxPages?: number)
List advertiserLandingPages resources
| Argument | Type | Description |
|---|---|---|
| advertiserIds? | string | Select only landing pages that belong to these advertisers. |
| archived? | boolean | Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. |
| campaignIds? | string | Select only landing pages that are associated with these campaigns. |
| ids? | string | Select only landing pages with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| subaccountId? | string | Select only landing pages that belong to this subaccount. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this advertiser.This is a read-only field that can be left blank. |
| advertiserGroupId? | string | ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. |
| clickThroughUrlSuffix? | string | Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. |
| defaultClickThroughEventTagId? | string | ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. |
| defaultEmail? | string | Default email address used in sender field for tag emails. |
| euPoliticalAdsDeclaration? | enum | Optional. Whether the advertiser plans to serve EU political ads. |
| floodlightConfigurationId? | string | Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. |
| floodlightConfigurationIdDimensionValue? | object | The name of the dimension. |
| id? | string | ID of this advertiser. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| measurementPartnerLink? | object | Status of the partner link. |
| name? | string | Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. |
| originalFloodlightConfigurationId? | string | Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. |
| status? | enum | Status of this advertiser. |
| subaccountId? | string | Subaccount ID of this advertiser.This is a read-only field that can be left blank. |
| suspended? | boolean | Suspension status of this advertiser. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a advertisers
fn get(identifier: string)
Get a advertisers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the advertisers |
fn update()
Update advertisers attributes
fn sync()
Sync advertisers state from GCP
fn list(advertiserGroupIds?: string, floodlightConfigurationIds?: string, ids?: string, includeAdvertisersWithoutGroupsOnly?: boolean, maxResults?: number, onlyParent?: boolean, searchString?: string, sortField?: string, sortOrder?: string, status?: string, subaccountId?: string, maxPages?: number)
List advertisers resources
| Argument | Type | Description |
|---|---|---|
| advertiserGroupIds? | string | Select only advertisers with these advertiser group IDs. |
| floodlightConfigurationIds? | string | Select only advertisers with these floodlight configuration IDs. |
| ids? | string | Select only advertisers with these IDs. |
| includeAdvertisersWithoutGroupsOnly? | boolean | Select only advertisers which do not belong to any advertiser group. |
| maxResults? | number | Maximum number of results to return. |
| onlyParent? | boolean | Select only advertisers which use another advertiser's floodlight configuration. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" . |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| status? | string | Select only advertisers with the specified status. |
| subaccountId? | string | Select only advertisers with these subaccount IDs. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
billingassignments.tsv2026.06.08.1
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. |
| accountId? | string | ID of the account associated with the billing assignment.This is a read-only, auto-generated field. |
| advertiserId? | string | ID of the advertiser associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single advertiser |
| campaignId? | string | ID of the campaign associated with the billing assignment. Wildcard (*) means this assignment is not limited to a single campaign |
| subaccountId? | string | ID of the subaccount associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single subaccountThis is a read-only, auto-generated field. |
| profileId | string | User profile ID associated with this request. |
| billingProfileId | string | Billing profile ID of this billing assignment. |
fn create()
Create a billingAssignments
fn get(identifier: string)
Get a billingAssignments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the billingAssignments |
fn sync()
Sync billingAssignments state from GCP
fn list(maxPages?: number)
List billingAssignments resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
billingprofiles.tsv2026.06.08.1
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. |
| consolidatedInvoice? | boolean | Consolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level. |
| countryCode? | string | Country code of this billing profile.This is a read-only field. |
| currencyCode? | string | Billing currency code in ISO 4217 format.This is a read-only field. |
| id? | string | ID of this billing profile. This is a read-only, auto-generated field. |
| invoiceLevel? | enum | Invoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign. |
| isDefault? | boolean | True if the billing profile is the account default profile. This is a read-only field. |
| kind? | string | Identifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile". |
| name? | string | Name of this billing profile. This is a required field and must be less than 256 characters long and must be unique among billing profile in the same account. |
| paymentsAccountId? | string | The ID of the payment account the billing profile belongs to. This is a read-only field. |
| paymentsCustomerId? | string | The ID of the payment customer the billing profile belongs to. This is a read-only field. |
| purchaseOrder? | string | Purchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile. |
| secondaryPaymentsCustomerId? | string | The ID of the secondary payment customer the billing profile belongs to. This is a read-only field. |
| status? | enum | Status of this billing profile.This is a read-only field. |
fn get(identifier: string)
Get a billingProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the billingProfiles |
fn update(waitForReady?: boolean)
Update billingProfiles attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync()
Sync billingProfiles state from GCP
fn list(currency_code?: string, ids?: string, maxResults?: number, name?: string, onlySuggestion?: boolean, sortField?: string, sortOrder?: string, status?: string, subaccountIds?: string, maxPages?: number)
List billingProfiles resources
| Argument | Type | Description |
|---|---|---|
| currency_code? | string | Select only billing profile with currency. |
| ids? | string | Select only billing profile with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| name? | string | Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, "profile*2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile". |
| onlySuggestion? | boolean | Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API. |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| status? | string | Select only billing profile with the specified status. |
| subaccountIds? | string | Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
billingrates.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a billingRates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the billingRates |
fn sync()
Sync billingRates state from GCP
fn list(maxPages?: number)
List billingRates resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
browsers.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a browsers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the browsers |
fn sync()
Sync browsers state from GCP
fn list(maxPages?: number)
List browsers resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
campaigncreativeassociations.tsv2026.06.08.1
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. |
| creativeId? | string | ID of the creative associated with the campaign. This is a required field. |
| profileId | string | User profile ID associated with this request. |
| campaignId | string | Campaign ID in this association. |
fn create()
Create a campaignCreativeAssociations
fn get(identifier: string)
Get a campaignCreativeAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the campaignCreativeAssociations |
fn sync()
Sync campaignCreativeAssociations state from GCP
fn list(maxResults?: number, sortOrder?: string, maxPages?: number)
List campaignCreativeAssociations resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
campaigns.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this campaign. This is a read-only field that can be left blank. |
| adBlockingConfiguration? | object | Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. |
| additionalCreativeOptimizationConfigurations? | array | ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. |
| advertiserGroupId? | string | Advertiser group ID of the associated advertiser. |
| advertiserId? | string | Advertiser ID of this campaign. This is a required field. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| archived? | boolean | Whether this campaign has been archived. |
| audienceSegmentGroups? | array | Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. |
| billingInvoiceCode? | string | Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. |
| clickThroughUrlSuffixProperties? | object | Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. |
| comment? | string | Arbitrary comments about this campaign. Must be less than 256 characters long. |
| createInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| creativeGroupIds? | array | List of creative group IDs that are assigned to the campaign. |
| creativeOptimizationConfiguration? | object | ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. |
| defaultClickThroughEventTagProperties? | object | ID of the click-through event tag to apply to all ads in this entity's scope. |
| defaultLandingPageId? | string | The default landing page ID for this campaign. |
| endDate? | string | |
| euPoliticalAdsDeclaration? | enum | Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions. |
| eventTagOverrides? | array | Whether this override is enabled. |
| externalId? | string | External ID for this campaign. |
| id? | string | ID of this campaign. This is a read-only auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| measurementPartnerLink? | object | . |
| name? | string | Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser. |
| startDate? | string | |
| subaccountId? | string | Subaccount ID of this campaign. This is a read-only field that can be left blank. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a campaigns
fn get(identifier: string)
Get a campaigns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the campaigns |
fn update()
Update campaigns attributes
fn sync()
Sync campaigns state from GCP
fn list(advertiserGroupIds?: string, advertiserIds?: string, archived?: boolean, atLeastOneOptimizationActivity?: boolean, excludedIds?: string, ids?: string, maxResults?: number, overriddenEventTagId?: string, searchString?: string, sortField?: string, sortOrder?: string, subaccountId?: string, maxPages?: number)
List campaigns resources
| Argument | Type | Description |
|---|---|---|
| advertiserGroupIds? | string | Select only campaigns whose advertisers belong to these advertiser groups. |
| advertiserIds? | string | Select only campaigns that belong to these advertisers. |
| archived? | boolean | Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. |
| atLeastOneOptimizationActivity? | boolean | Select only campaigns that have at least one optimization activity. |
| excludedIds? | string | Exclude campaigns with these IDs. |
| ids? | string | Select only campaigns with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| overriddenEventTagId? | string | Select only campaigns that have overridden this event tag ID. |
| searchString? | string | Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| subaccountId? | string | Select only campaigns that belong to this subaccount. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
changelogs.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a changeLogs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the changeLogs |
fn sync()
Sync changeLogs state from GCP
fn list(action?: string, ids?: string, maxChangeTime?: string, maxResults?: number, minChangeTime?: string, objectIds?: string, objectType?: string, searchString?: string, userProfileIds?: string, maxPages?: number)
List changeLogs resources
| Argument | Type | Description |
|---|---|---|
| action? | string | Select only change logs with the specified action. |
| ids? | string | Select only change logs with these IDs. |
| maxChangeTime? | string | Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. |
| maxResults? | number | Maximum number of results to return. |
| minChangeTime? | string | Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. |
| objectIds? | string | Select only change logs with these object IDs. |
| objectType? | string | Select only change logs with the specified object type. |
| searchString? | string | Select only change logs whose object ID, user name, old or new values match the search string. |
| userProfileIds? | string | Select only change logs with these user profile IDs. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
cities.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a cities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cities |
fn sync()
Sync cities state from GCP
fn list(countryDartIds?: string, dartIds?: string, namePrefix?: string, regionDartIds?: string, maxPages?: number)
List cities resources
| Argument | Type | Description |
|---|---|---|
| countryDartIds? | string | Select only cities from these countries. |
| dartIds? | string | Select only cities with these DART IDs. |
| namePrefix? | string | Select only cities with names starting with this prefix. |
| regionDartIds? | string | Select only cities from these regions. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
connectiontypes.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a connectionTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the connectionTypes |
fn sync()
Sync connectionTypes state from GCP
fn list(maxPages?: number)
List connectionTypes resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
contentcategories.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this content category. This is a read-only field that can be left blank. |
| id? | string | ID of this content category. This is a read-only, auto-generated field. |
| name? | string | Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a contentCategories
fn get(identifier: string)
Get a contentCategories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the contentCategories |
fn update()
Update contentCategories attributes
fn delete(identifier: string)
Delete the contentCategories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the contentCategories |
fn sync()
Sync contentCategories state from GCP
fn list(ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List contentCategories resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Select only content categories with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
countries.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a countries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the countries |
fn sync()
Sync countries state from GCP
fn list(maxPages?: number)
List countries resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
creativefields.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this creative field. This is a read-only field that can be left blank. |
| advertiserId? | string | Advertiser ID of this creative field. This is a required field on insertion. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| id? | string | ID of this creative field. This is a read-only, auto-generated field. |
| name? | string | Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. |
| subaccountId? | string | Subaccount ID of this creative field. This is a read-only field that can be left blank. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a creativeFields
fn get(identifier: string)
Get a creativeFields
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the creativeFields |
fn update()
Update creativeFields attributes
fn delete(identifier: string)
Delete the creativeFields
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the creativeFields |
fn sync()
Sync creativeFields state from GCP
fn list(advertiserIds?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List creativeFields resources
| Argument | Type | Description |
|---|---|---|
| advertiserIds? | string | Select only creative fields that belong to these advertisers. |
| ids? | string | Select only creative fields with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
creativefieldvalues.tsv2026.06.08.1
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. |
| id? | string | ID of this creative field value. This is a read-only, auto-generated field. |
| value? | string | Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. |
| profileId | string | User profile ID associated with this request. |
| creativeFieldId | string | Creative field ID for this creative field value. |
fn create()
Create a creativeFieldValues
fn get(identifier: string)
Get a creativeFieldValues
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the creativeFieldValues |
fn update()
Update creativeFieldValues attributes
fn delete(identifier: string)
Delete the creativeFieldValues
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the creativeFieldValues |
fn sync()
Sync creativeFieldValues state from GCP
fn list(ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List creativeFieldValues resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Select only creative field values with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
creativegroups.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this creative group. This is a read-only field that can be left blank. |
| advertiserId? | string | Advertiser ID of this creative group. This is a required field on insertion. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| groupNumber? | number | Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. |
| id? | string | ID of this creative group. This is a read-only, auto-generated field. |
| name? | string | Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. |
| subaccountId? | string | Subaccount ID of this creative group. This is a read-only field that can be left blank. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a creativeGroups
fn get(identifier: string)
Get a creativeGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the creativeGroups |
fn update()
Update creativeGroups attributes
fn sync()
Sync creativeGroups state from GCP
fn list(advertiserIds?: string, groupNumber?: number, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List creativeGroups resources
| Argument | Type | Description |
|---|---|---|
| advertiserIds? | string | Select only creative groups that belong to these advertisers. |
| groupNumber? | number | Select only creative groups that belong to this subgroup. |
| ids? | string | Select only creative groups with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
creatives.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. |
| active? | boolean | Whether the creative is active. Applicable to all creative types. |
| adParameters? | string | Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. |
| adTagKeys? | array | Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| additionalSizes? | array | Height of this size. Acceptable values are 0 to 32767, inclusive. |
| advertiserId? | string | Required. Advertiser ID of this creative. This is a required field. Applicable to all creative types. |
| allowScriptAccess? | boolean | Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. |
| archived? | boolean | Whether the creative is archived. Applicable to all creative types. |
| artworkType? | enum | Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| authoringSource? | enum | Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. |
| authoringTool? | enum | Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. |
| autoAdvanceImages? | boolean | Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. |
| backgroundColor? | string | The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. |
| backupImageClickThroughUrl? | object | Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. |
| backupImageFeatures? | array | List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. |
| backupImageReportingLabel? | string | Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. |
| backupImageTargetWindow? | object | User-entered value. |
| clickTags? | array | Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. |
| commercialId? | string | Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. |
| companionCreatives? | array | List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. |
| compatibility? | array | Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" |
| convertFlashToHtml5? | boolean | Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. |
| counterCustomEvents? | array | Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. |
| creativeAssets? | array | Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. |
| creativeFieldAssignments? | array | ID of the creative field. |
| customKeyValues? | array | Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| exitCustomEvents? | array | Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. |
| fsCommand? | object | Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. |
| htmlCode? | string | HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. |
| htmlCodeLocked? | boolean | Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. |
| id? | string | ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. |
| idDimensionValue? | object | The name of the dimension. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| latestTraffickedCreativeId? | string | Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| mediaDescription? | string | Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. |
| mediaDuration? | number | Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. |
| name? | string | Required. Name of the creative. This must be less than 256 characters long. Applicable to all creative types. |
| obaIcon? | object | URL to redirect to when an OBA icon is clicked. |
| overrideCss? | string | Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. |
| progressOffset? | object | Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. |
| redirectUrl? | string | URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT |
| renderingId? | string | ID of current rendering version. This is a read-only field. Applicable to all creative types. |
| renderingIdDimensionValue? | object | The name of the dimension. |
| requiredFlashPluginVersion? | string | The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| requiredFlashVersion? | number | The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. |
| size? | object | Height of this size. Acceptable values are 0 to 32767, inclusive. |
| skipOffset? | object | Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. |
| skippable? | boolean | Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. |
| sslCompliant? | boolean | Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. |
| sslOverride? | boolean | Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. |
| studioAdvertiserId? | string | Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| studioCreativeId? | string | Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| studioTraffickedCreativeId? | string | Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| subaccountId? | string | Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. |
| thirdPartyBackupImageImpressionsUrl? | string | Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. |
| thirdPartyRichMediaImpressionsUrl? | string | Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. |
| thirdPartyUrls? | array | Third-party URL type for in-stream video and in-stream audio creatives. |
| timerCustomEvents? | array | Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. |
| totalFileSize? | string | Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. |
| type? | enum | Required. Type of this creative. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. |
| universalAdId? | object | Registry used for the Ad ID value. |
| version? | number | The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a creatives
fn get(identifier: string)
Get a creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the creatives |
fn update()
Update creatives attributes
fn sync()
Sync creatives state from GCP
fn list(active?: boolean, advertiserId?: string, archived?: boolean, campaignId?: string, companionCreativeIds?: string, creativeFieldIds?: string, ids?: string, maxResults?: number, renderingIds?: string, searchString?: string, sizeIds?: string, sortField?: string, sortOrder?: string, studioCreativeId?: string, types?: string, maxPages?: number)
List creatives resources
| Argument | Type | Description |
|---|---|---|
| active? | boolean | Select only active creatives. Leave blank to select active and inactive creatives. |
| advertiserId? | string | Select only creatives with this advertiser ID. |
| archived? | boolean | Select only archived creatives. Leave blank to select archived and unarchived creatives. |
| campaignId? | string | Select only creatives with this campaign ID. |
| companionCreativeIds? | string | Select only in-stream video creatives with these companion IDs. |
| creativeFieldIds? | string | Select only creatives with these creative field IDs. |
| ids? | string | Select only creatives with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| renderingIds? | string | Select only creatives with these rendering IDs. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". |
| sizeIds? | string | Select only creatives with these size IDs. |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| studioCreativeId? | string | Select only creatives corresponding to this Studio creative ID. |
| types? | string | Select only creatives with these creative types. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
directorysites.tsv2026.06.08.1
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. |
| id? | string | ID of this directory site. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| inpageTagFormats? | array | Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" |
| interstitialTagFormats? | array | Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" |
| name? | string | Name of this directory site. |
| settings? | object | Whether this directory site has disabled active view creatives. |
| url? | string | URL of this directory site. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a directorySites
fn get(identifier: string)
Get a directorySites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the directorySites |
fn sync()
Sync directorySites state from GCP
fn list(acceptsInStreamVideoPlacements?: boolean, acceptsInterstitialPlacements?: boolean, acceptsPublisherPaidPlacements?: boolean, active?: boolean, dfpNetworkCode?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List directorySites resources
| Argument | Type | Description |
|---|---|---|
| acceptsInStreamVideoPlacements? | boolean | This search filter is no longer supported and will have no effect on the results returned. |
| acceptsInterstitialPlacements? | boolean | This search filter is no longer supported and will have no effect on the results returned. |
| acceptsPublisherPaidPlacements? | boolean | Select only directory sites that accept publisher paid placements. This field can be left blank. |
| active? | boolean | Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. |
| dfpNetworkCode? | string | Select only directory sites with this Ad Manager network code. |
| ids? | string | Select only directory sites with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
dynamicfeeds.tsv2026.06.08.1
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. |
| dynamicFeed? | object | Optional. The name of the content source. It is defaulted to content source file name if not provided. |
| dynamicProfileId? | string | Required. Dynamic profile ID of the inserted dynamic feed. |
| contentSource? | object | Optional. The name of the content source. It is defaulted to content source file name if not provided. |
| createInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| dynamicFeedId? | string | Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field. |
| dynamicFeedName? | string | Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided. |
| element? | object | Optional. The field ID to specify the active field in the feed. |
| feedIngestionStatus? | object | Output only. The ID of the field. |
| feedSchedule? | object | Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive. |
| hasPublished? | boolean | Output only. Indicates whether the dynamic feed has a published version. This is a read-only field. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| status? | enum | Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully. |
| studioAdvertiserId? | string | Required. Advertiser ID of this dynamic feed. This is a required field. |
fn create(waitForReady?: boolean)
Create a dynamicFeeds
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a dynamicFeeds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dynamicFeeds |
fn update(waitForReady?: boolean)
Update dynamicFeeds attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync()
Sync dynamicFeeds state from GCP
fn retransform()
retransform
dynamicprofiles.tsv2026.06.08.1
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. |
| active? | object | Optional. Dynamic feed ID associated with dynamic profile version. |
| archiveStatus? | enum | Optional. Archive status of this dynamic profile. |
| createInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| description? | string | Optional. Description of this dynamic profile. |
| draft? | object | Optional. Dynamic feed ID associated with dynamic profile version. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| name? | string | Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| status? | enum | Optional. Status of this dynamic profile. |
| studioAdvertiserId? | string | Required. Advertiser ID of this dynamic profile. This is a required field on insertion. |
fn create(waitForReady?: boolean)
Create a dynamicProfiles
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a dynamicProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dynamicProfiles |
fn update(waitForReady?: boolean)
Update dynamicProfiles attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync()
Sync dynamicProfiles state from GCP
fn generate_code()
generate code
fn publish()
publish
dynamictargetingkeys.tsv2026.06.08.1
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. |
| name? | string | Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. |
| objectId? | string | ID of the object of this dynamic targeting key. This is a required field. |
| objectType? | enum | Type of the object of this dynamic targeting key. This is a required field. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a dynamicTargetingKeys
fn get(identifier: string)
Get a dynamicTargetingKeys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dynamicTargetingKeys |
fn delete(identifier: string)
Delete the dynamicTargetingKeys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dynamicTargetingKeys |
fn sync()
Sync dynamicTargetingKeys state from GCP
fn list(advertiserId?: string, names?: string, objectId?: string, objectType?: string, maxPages?: number)
List dynamicTargetingKeys resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | Select only dynamic targeting keys whose object has this advertiser ID. |
| names? | string | Select only dynamic targeting keys exactly matching these names. |
| objectId? | string | Select only dynamic targeting keys with this object ID. |
| objectType? | string | Select only dynamic targeting keys with this object type. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
eventtags.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this event tag. This is a read-only field that can be left blank. |
| advertiserId? | string | Advertiser ID of this event tag. This field or the campaignId field is required on insertion. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| campaignId? | string | Campaign ID of this event tag. This field or the advertiserId field is required on insertion. |
| campaignIdDimensionValue? | object | The name of the dimension. |
| enabledByDefault? | boolean | Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. |
| excludeFromAdxRequests? | boolean | Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. |
| id? | string | ID of this event tag. This is a read-only, auto-generated field. |
| name? | string | Name of this event tag. This is a required field and must be less than 256 characters long. |
| siteFilterType? | enum | Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. |
| siteIds? | array | Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter. |
| sslCompliant? | boolean | Whether this tag is SSL-compliant or not. This is a read-only field. |
| status? | enum | Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. |
| subaccountId? | string | Subaccount ID of this event tag. This is a read-only field that can be left blank. |
| type? | enum | Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. |
| url? | string | Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. |
| urlEscapeLevels? | number | Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. |
| profileId | string | User profile ID associated with this request. |
fn create(waitForReady?: boolean)
Create a eventTags
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a eventTags
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the eventTags |
fn update(waitForReady?: boolean)
Update eventTags attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the eventTags
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the eventTags |
fn sync()
Sync eventTags state from GCP
fn list(adId?: string, advertiserId?: string, campaignId?: string, definitionsOnly?: boolean, enabled?: boolean, eventTagTypes?: string, ids?: string, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List eventTags resources
| Argument | Type | Description |
|---|---|---|
| adId? | string | Select only event tags that belong to this ad. |
| advertiserId? | string | Select only event tags that belong to this advertiser. |
| campaignId? | string | Select only event tags that belong to this campaign. |
| definitionsOnly? | boolean | Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. |
| enabled? | boolean | Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. |
| eventTagTypes? | string | Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. |
| ids? | string | Select only event tags with these IDs. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
files.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a files
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the files |
fn sync()
Sync files state from GCP
fn list(maxResults?: number, scope?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List files resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| scope? | string | The scope that defines which results are returned. |
| sortField? | string | The field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
floodlightactivities.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this floodlight activity. This is a read-only field that can be left blank. |
| advertiserId? | string | Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| attributionEnabled? | boolean | Whether the activity is enabled for attribution. |
| cacheBustingType? | enum | Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. |
| conversionCategory? | enum | Required. The conversion category of the activity. |
| countingMethod? | enum | Counting method for conversions for this floodlight activity. This is a required field. |
| defaultTags? | array | ID of this dynamic tag. This is a read-only, auto-generated field. |
| expectedUrl? | string | URL where this tag will be deployed. If specified, must be less than 256 characters long. |
| floodlightActivityGroupId? | string | Floodlight activity group ID of this floodlight activity. This is a required field. |
| floodlightActivityGroupName? | string | Name of the associated floodlight activity group. This is a read-only field. |
| floodlightActivityGroupTagString? | string | Tag string of the associated floodlight activity group. This is a read-only field. |
| floodlightActivityGroupType? | enum | Type of the associated floodlight activity group. This is a read-only field. |
| floodlightConfigurationId? | string | Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. |
| floodlightConfigurationIdDimensionValue? | object | The name of the dimension. |
| floodlightTagType? | enum | The type of Floodlight tag this activity will generate. This is a required field. |
| id? | string | ID of this floodlight activity. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| name? | string | Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. |
| notes? | string | General notes or implementation instructions for the tag. |
| publisherTags? | array | Whether this tag is applicable only for click-throughs. |
| secure? | boolean | Whether this tag should use SSL. |
| sslCompliant? | boolean | Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. |
| sslRequired? | boolean | Whether this floodlight activity must be SSL-compliant. |
| status? | enum | The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information. |
| subaccountId? | string | Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. |
| tagFormat? | enum | Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. |
| tagString? | string | Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. |
| userDefinedVariableTypes? | array | List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. |
| profileId | string | User profile ID associated with this request. |
fn create(waitForReady?: boolean)
Create a floodlightActivities
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a floodlightActivities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the floodlightActivities |
fn update(waitForReady?: boolean)
Update floodlightActivities attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the floodlightActivities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the floodlightActivities |
fn sync()
Sync floodlightActivities state from GCP
fn list(advertiserId?: string, floodlightActivityGroupIds?: string, floodlightActivityGroupName?: string, floodlightActivityGroupTagString?: string, floodlightActivityGroupType?: string, floodlightConfigurationId?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, tagString?: string, maxPages?: number)
List floodlightActivities resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. |
| floodlightActivityGroupIds? | string | Select only floodlight activities with the specified floodlight activity group IDs. |
| floodlightActivityGroupName? | string | Select only floodlight activities with the specified floodlight activity group name. |
| floodlightActivityGroupTagString? | string | Select only floodlight activities with the specified floodlight activity group tag string. |
| floodlightActivityGroupType? | string | Select only floodlight activities with the specified floodlight activity group type. |
| floodlightConfigurationId? | string | Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. |
| ids? | string | Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| tagString? | string | Select only floodlight activities with the specified tag string. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn generatetag()
generatetag
floodlightactivitygroups.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this floodlight activity group. This is a read-only field that can be left blank. |
| advertiserId? | string | Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| floodlightConfigurationId? | string | Floodlight configuration ID of this floodlight activity group. This is a required field. |
| floodlightConfigurationIdDimensionValue? | object | The name of the dimension. |
| id? | string | ID of this floodlight activity group. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| name? | string | Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. |
| subaccountId? | string | Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. |
| tagString? | string | Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. |
| type? | enum | Type of the floodlight activity group. This is a required field that is read-only after insertion. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a floodlightActivityGroups
fn get(identifier: string)
Get a floodlightActivityGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the floodlightActivityGroups |
fn update()
Update floodlightActivityGroups attributes
fn sync()
Sync floodlightActivityGroups state from GCP
fn list(advertiserId?: string, floodlightConfigurationId?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, type?: string, maxPages?: number)
List floodlightActivityGroups resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. |
| floodlightConfigurationId? | string | Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. |
| ids? | string | Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| type? | string | Select only floodlight activity groups with the specified floodlight activity group type. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
floodlightconfigurations.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this floodlight configuration. This is a read-only field that can be left blank. |
| advertiserId? | string | Advertiser ID of the parent advertiser of this floodlight configuration. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| analyticsDataSharingEnabled? | boolean | Whether advertiser data is shared with Google Analytics. |
| customViewabilityMetric? | object | Whether the video must be audible to count an impression. |
| exposureToConversionEnabled? | boolean | Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. |
| firstDayOfWeek? | enum | |
| id? | string | ID of this floodlight configuration. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| inAppAttributionTrackingEnabled? | boolean | Whether in-app attribution tracking is enabled. |
| kind? | string | Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". |
| lookbackConfiguration? | object | Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. |
| naturalSearchConversionAttributionOption? | enum | Types of attribution options for natural search conversions. |
| omnitureSettings? | object | Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. |
| subaccountId? | string | Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. |
| tagSettings? | object | Whether dynamic floodlight tags are enabled. |
| thirdPartyAuthenticationTokens? | array | Name of the third-party authentication token. |
| userDefinedVariableConfigurations? | array | Data type for the variable. This is a required field. |
fn get(identifier: string)
Get a floodlightConfigurations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the floodlightConfigurations |
fn update()
Update floodlightConfigurations attributes
fn sync()
Sync floodlightConfigurations state from GCP
fn list(ids?: string, maxPages?: number)
List floodlightConfigurations resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
languages.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a languages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the languages |
fn sync()
Sync languages state from GCP
fn list(maxPages?: number)
List languages resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
metros.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a metros
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the metros |
fn sync()
Sync metros state from GCP
fn list(maxPages?: number)
List metros resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
mobileapps.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a mobileApps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the mobileApps |
fn sync()
Sync mobileApps state from GCP
fn list(directories?: string, ids?: string, maxResults?: number, searchString?: string, maxPages?: number)
List mobileApps resources
| Argument | Type | Description |
|---|---|---|
| directories? | string | Select only apps from these directories. |
| ids? | string | Select only apps with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
mobilecarriers.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a mobileCarriers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the mobileCarriers |
fn sync()
Sync mobileCarriers state from GCP
fn list(maxPages?: number)
List mobileCarriers resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
operatingsystems.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a operatingSystems
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the operatingSystems |
fn sync()
Sync operatingSystems state from GCP
fn list(maxPages?: number)
List operatingSystems resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
operatingsystemversions.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a operatingSystemVersions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the operatingSystemVersions |
fn sync()
Sync operatingSystemVersions state from GCP
fn list(maxPages?: number)
List operatingSystemVersions resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
placementgroups.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this placement group. This is a read-only field that can be left blank. |
| activeStatus? | enum | Whether this placement group is active, inactive, archived or permanently archived. |
| advertiserId? | string | Advertiser ID of this placement group. This is a required field on insertion. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| campaignId? | string | Campaign ID of this placement group. This field is required on insertion. |
| campaignIdDimensionValue? | object | The name of the dimension. |
| childPlacementIds? | array | IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. |
| comment? | string | Comments for this placement group. |
| contentCategoryId? | string | ID of the content category assigned to this placement group. |
| createInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| directorySiteId? | string | Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. |
| directorySiteIdDimensionValue? | object | The name of the dimension. |
| externalId? | string | External ID for this placement. |
| id? | string | ID of this placement group. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| name? | string | Name of this placement group. This is a required field and must be less than 256 characters long. |
| placementGroupType? | enum | Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. |
| placementStrategyId? | string | ID of the placement strategy assigned to this placement group. |
| pricingSchedule? | object | Placement cap cost option. |
| primaryPlacementId? | string | ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. |
| primaryPlacementIdDimensionValue? | object | The name of the dimension. |
| siteId? | string | Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. |
| siteIdDimensionValue? | object | The name of the dimension. |
| subaccountId? | string | Subaccount ID of this placement group. This is a read-only field that can be left blank. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a placementGroups
fn get(identifier: string)
Get a placementGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the placementGroups |
fn update()
Update placementGroups attributes
fn sync()
Sync placementGroups state from GCP
fn list(activeStatus?: string, advertiserIds?: string, campaignIds?: string, contentCategoryIds?: string, directorySiteIds?: string, ids?: string, maxEndDate?: string, maxResults?: number, maxStartDate?: string, minEndDate?: string, minStartDate?: string, placementGroupType?: string, placementStrategyIds?: string, pricingTypes?: string, searchString?: string, siteIds?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List placementGroups resources
| Argument | Type | Description |
|---|---|---|
| activeStatus? | string | Select only placements with these active statuses. |
| advertiserIds? | string | Select only placement groups that belong to these advertisers. |
| campaignIds? | string | Select only placement groups that belong to these campaigns. |
| contentCategoryIds? | string | Select only placement groups that are associated with these content categories. |
| directorySiteIds? | string | Select only placement groups that are associated with these directory sites. |
| ids? | string | Select only placement groups with these IDs. |
| maxEndDate? | string | Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". |
| maxResults? | number | Maximum number of results to return. |
| maxStartDate? | string | Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". |
| minEndDate? | string | Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". |
| minStartDate? | string | Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". |
| placementGroupType? | string | Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. |
| placementStrategyIds? | string | Select only placement groups that are associated with these placement strategies. |
| pricingTypes? | string | Select only placement groups with these pricing types. |
| searchString? | string | Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". |
| siteIds? | string | Select only placement groups that are associated with these sites. |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
placements.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this placement. This field can be left blank. |
| activeStatus? | enum | Whether this placement is active, inactive, archived or permanently archived. |
| adBlockingOptOut? | boolean | Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. |
| adServingPlatformId? | string | Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint |
| additionalSizes? | array | Height of this size. Acceptable values are 0 to 32767, inclusive. |
| advertiserId? | string | Advertiser ID of this placement. This field can be left blank. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| allowOnYoutube? | boolean | Optional. Whether the placement is enabled for YouTube integration. |
| campaignId? | string | Campaign ID of this placement. This field is a required field on insertion. |
| campaignIdDimensionValue? | object | The name of the dimension. |
| comment? | string | Comments for this placement. |
| compatibility? | enum | Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. |
| contentCategoryId? | string | ID of the content category assigned to this placement. |
| conversionDomainOverride? | object | |
| createInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| directorySiteId? | string | Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. |
| directorySiteIdDimensionValue? | object | The name of the dimension. |
| externalId? | string | External ID for this placement. |
| id? | string | ID of this placement. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| keyName? | string | Key name of this placement. This is a read-only, auto-generated field. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| lookbackConfiguration? | object | Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. |
| name? | string | Name of this placement.This is a required field and must be less than or equal to 512 characters long. |
| partnerWrappingData? | object | Placement wrapping status. |
| paymentApproved? | boolean | Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. |
| paymentSource? | enum | Payment source for this placement. This is a required field that is read-only after insertion. |
| placementGroupId? | string | ID of this placement's group, if applicable. |
| placementGroupIdDimensionValue? | object | The name of the dimension. |
| placementStrategyId? | string | ID of the placement strategy assigned to this placement. |
| pricingSchedule? | object | Placement cap cost option. |
| primary? | boolean | Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. |
| publisherUpdateInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| siteId? | string | Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. |
| siteIdDimensionValue? | object | The name of the dimension. |
| siteServed? | boolean | Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM. |
| size? | object | Height of this size. Acceptable values are 0 to 32767, inclusive. |
| sslRequired? | boolean | Whether creatives assigned to this placement must be SSL-compliant. |
| status? | enum | Third-party placement status. |
| subaccountId? | string | Subaccount ID of this placement. This field can be left blank. |
| tagFormats? | array | Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" |
| tagSetting? | object | Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. |
| videoActiveViewOptOut? | boolean | Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. |
| videoSettings? | object | Whether companions are disabled for this placement. |
| vpaidAdapterChoice? | enum | VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. |
| wrappingOptOut? | boolean | Whether this placement opts out of tag wrapping. |
| youtubeSettings? | object | Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a placements
fn get(identifier: string)
Get a placements
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the placements |
fn update()
Update placements attributes
fn sync()
Sync placements state from GCP
fn list(activeStatus?: string, advertiserIds?: string, campaignIds?: string, compatibilities?: string, contentCategoryIds?: string, directorySiteIds?: string, groupIds?: string, ids?: string, maxEndDate?: string, maxResults?: number, maxStartDate?: string, minEndDate?: string, minStartDate?: string, paymentSource?: string, placementStrategyIds?: string, pricingTypes?: string, searchString?: string, siteIds?: string, sizeIds?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List placements resources
| Argument | Type | Description |
|---|---|---|
| activeStatus? | string | Select only placements with these active statuses. |
| advertiserIds? | string | Select only placements that belong to these advertisers. |
| campaignIds? | string | Select only placements that belong to these campaigns. |
| compatibilities? | string | Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. |
| contentCategoryIds? | string | Select only placements that are associated with these content categories. |
| directorySiteIds? | string | Select only placements that are associated with these directory sites. |
| groupIds? | string | Select only placements that belong to these placement groups. |
| ids? | string | Select only placements with these IDs. |
| maxEndDate? | string | Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". |
| maxResults? | number | Maximum number of results to return. |
| maxStartDate? | string | Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". |
| minEndDate? | string | Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". |
| minStartDate? | string | Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". |
| paymentSource? | string | Select only placements with this payment source. |
| placementStrategyIds? | string | Select only placements that are associated with these placement strategies. |
| pricingTypes? | string | Select only placements with these pricing types. |
| searchString? | string | Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement" . |
| siteIds? | string | Select only placements that are associated with these sites. |
| sizeIds? | string | Select only placements that are associated with these sizes. |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn generatetags()
generatetags
placementstrategies.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this placement strategy.This is a read-only field that can be left blank. |
| id? | string | ID of this placement strategy. This is a read-only, auto-generated field. |
| name? | string | Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a placementStrategies
fn get(identifier: string)
Get a placementStrategies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the placementStrategies |
fn update()
Update placementStrategies attributes
fn delete(identifier: string)
Delete the placementStrategies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the placementStrategies |
fn sync()
Sync placementStrategies state from GCP
fn list(ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List placementStrategies resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Select only placement strategies with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
platformtypes.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a platformTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the platformTypes |
fn sync()
Sync platformTypes state from GCP
fn list(maxPages?: number)
List platformTypes resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
postalcodes.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a postalCodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the postalCodes |
fn sync()
Sync postalCodes state from GCP
fn list(maxPages?: number)
List postalCodes resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
regions.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a regions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the regions |
fn sync()
Sync regions state from GCP
fn list(maxPages?: number)
List regions resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
remarketinglists.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| active? | boolean | Whether this remarketing list is active. |
| advertiserId? | string | Dimension value for the advertiser ID that owns this remarketing list. This is a required field. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| description? | string | Remarketing list description. |
| id? | string | Remarketing list ID. This is a read-only, auto-generated field. |
| lifeSpan? | string | Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. |
| listPopulationRule? | object | Floodlight activity ID associated with this rule. This field can be left blank. |
| listSize? | string | Number of users currently in the list. This is a read-only field. |
| listSource? | enum | Product from which this remarketing list was originated. |
| name? | string | Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. |
| subaccountId? | string | Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a remarketingLists
fn get(identifier: string)
Get a remarketingLists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the remarketingLists |
fn update()
Update remarketingLists attributes
fn sync()
Sync remarketingLists state from GCP
fn list(active?: boolean, advertiserId?: string, floodlightActivityId?: string, maxResults?: number, name?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List remarketingLists resources
| Argument | Type | Description |
|---|---|---|
| active? | boolean | Select only active or only inactive remarketing lists. |
| advertiserId? | string | Required. Select only remarketing lists owned by this advertiser. |
| floodlightActivityId? | string | Select only remarketing lists that have this floodlight activity ID. |
| maxResults? | number | Maximum number of results to return. |
| name? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
remarketinglistshares.tsv2026.06.08.1
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. |
| kind? | string | Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". |
| remarketingListId? | string | Remarketing list ID. This is a read-only, auto-generated field. |
| sharedAccountIds? | array | Accounts that the remarketing list is shared with. |
| sharedAdvertiserIds? | array | Advertisers that the remarketing list is shared with. |
fn get(identifier: string)
Get a remarketingListShares
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the remarketingListShares |
fn update()
Update remarketingListShares attributes
fn sync()
Sync remarketingListShares state from GCP
reports.tsv2026.06.08.1
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. |
| accountId? | string | The account ID to which this report belongs. |
| criteria? | object | The name of the dimension. |
| crossMediaReachCriteria? | object | The kind of resource this is, in this case dfareporting#dateRange. |
| delivery? | object | Whether the report should be emailed to the report owner. |
| fileName? | string | The filename used when generating report files for this report. |
| floodlightCriteria? | object | The name of the dimension. |
| format? | enum | The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report\'s size exceeds the format\'s capabilities. "CSV" will then be the fallback format. |
| id? | string | The unique ID identifying this report resource. |
| lastModifiedTime? | string | The timestamp (in milliseconds since epoch) of when this report was last modified. |
| name? | string | The name of the report. |
| ownerProfileId? | string | The user profile id of the owner of this report. |
| pathToConversionCriteria? | object | The name of the dimension. |
| reachCriteria? | object | The name of the dimension. |
| schedule? | object | Whether the schedule is active or not. Must be set to either true or false. |
| subAccountId? | string | The subaccount ID to which this report belongs if applicable. |
| type? | enum | The type of the report. |
| profileId | string | The Campaign Manager 360 user profile ID. |
fn create()
Create a reports
fn get(identifier: string)
Get a reports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the reports |
fn update()
Update reports attributes
fn delete(identifier: string)
Delete the reports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the reports |
fn sync()
Sync reports state from GCP
fn list(maxResults?: number, scope?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List reports resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| scope? | string | The scope that defines which results are returned. |
| sortField? | string | The field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn run()
run
reports_files.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a files
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the files |
fn sync()
Sync files state from GCP
fn list(maxResults?: number, sortField?: string, sortOrder?: string, maxPages?: number)
List files resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| sortField? | string | The field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
sites.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this site. This is a read-only field that can be left blank. |
| adServingPlatformId? | string | Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint |
| approved? | boolean | Whether this site is approved. |
| directorySiteId? | string | Directory site associated with this site. This is a required field that is read-only after insertion. |
| directorySiteIdDimensionValue? | object | The name of the dimension. |
| id? | string | ID of this site. This is a read-only, auto-generated field. |
| idDimensionValue? | object | The name of the dimension. |
| keyName? | string | Key name of this site. This is a read-only, auto-generated field. |
| name? | string | Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. |
| siteContacts? | array | Address of this site contact. |
| siteSettings? | object | Whether active view creatives are disabled for this site. |
| subaccountId? | string | Subaccount ID of this site. This is a read-only field that can be left blank. |
| videoSettings? | object | Whether companions are disabled for this site template. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a sites
fn get(identifier: string)
Get a sites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the sites |
fn update()
Update sites attributes
fn sync()
Sync sites state from GCP
fn list(acceptsInStreamVideoPlacements?: boolean, acceptsInterstitialPlacements?: boolean, acceptsPublisherPaidPlacements?: boolean, adWordsSite?: boolean, approved?: boolean, campaignIds?: string, directorySiteIds?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, subaccountId?: string, unmappedSite?: boolean, maxPages?: number)
List sites resources
| Argument | Type | Description |
|---|---|---|
| acceptsInStreamVideoPlacements? | boolean | This search filter is no longer supported and will have no effect on the results returned. |
| acceptsInterstitialPlacements? | boolean | This search filter is no longer supported and will have no effect on the results returned. |
| acceptsPublisherPaidPlacements? | boolean | Select only sites that accept publisher paid placements. |
| adWordsSite? | boolean | Select only AdWords sites. |
| approved? | boolean | Select only approved sites. |
| campaignIds? | string | Select only sites with these campaign IDs. |
| directorySiteIds? | string | Select only sites with these directory site IDs. |
| ids? | string | Select only sites with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| subaccountId? | string | Select only sites with this subaccount ID. |
| unmappedSite? | boolean | Select only sites that have not been mapped to a directory site. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
sizes.tsv2026.06.08.1
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. |
| height? | number | Height of this size. Acceptable values are 0 to 32767, inclusive. |
| iab? | boolean | IAB standard size. This is a read-only, auto-generated field. |
| id? | string | ID of this size. This is a read-only, auto-generated field. |
| width? | number | Width of this size. Acceptable values are 0 to 32767, inclusive. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a sizes
fn get(identifier: string)
Get a sizes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the sizes |
fn sync()
Sync sizes state from GCP
fn list(height?: number, iabStandard?: boolean, ids?: string, width?: number, maxPages?: number)
List sizes resources
| Argument | Type | Description |
|---|---|---|
| height? | number | Select only sizes with this height. |
| iabStandard? | boolean | Select only IAB standard sizes. |
| ids? | string | Select only sizes with these IDs. |
| width? | number | Select only sizes with this width. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
studiocreatives.tsv2026.06.08.1
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. |
| assetIds? | array | List of assets associated with this studio creative. It is a required field on insertion. |
| backupImageAssetId? | string | Backup image asset ID of this studio creative. It is a required field on insertion. |
| createdInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| dimension? | object | Height of the studio creative. |
| dynamicProfileId? | string | Dynamic profile ID of this studio creative. |
| format? | enum | Format of this studio creative. This is a required field on insertion. |
| lastModifiedInfo? | object | Timestamp of the last change in milliseconds since epoch. |
| name? | string | Identifier. Name of this studio creative. This is a required field on insertion. |
| studioAccountId? | string | Studio account ID of this creative. This field, if left unset, will be auto-populated. |
| studioAdvertiserId? | string | Studio advertiser ID of this studio creative. This is a required field on insertion. |
| studioCampaignId? | string | Studio campaign ID of this studio creative. This is a required field on insertion. |
fn create()
Create a studioCreatives
fn get(identifier: string)
Get a studioCreatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the studioCreatives |
fn sync()
Sync studioCreatives state from GCP
fn publish()
publish
subaccounts.tsv2026.06.08.1
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. |
| accountId? | string | ID of the account that contains this subaccount. This is a read-only field that can be left blank. |
| availablePermissionIds? | array | IDs of the available user role permissions for this subaccount. |
| id? | string | ID of this subaccount. This is a read-only, auto-generated field. |
| name? | string | Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a subaccounts
fn get(identifier: string)
Get a subaccounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the subaccounts |
fn update()
Update subaccounts attributes
fn sync()
Sync subaccounts state from GCP
fn list(ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List subaccounts resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Select only subaccounts with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" . |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
targetableremarketinglists.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a targetableRemarketingLists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the targetableRemarketingLists |
fn sync()
Sync targetableRemarketingLists state from GCP
fn list(active?: boolean, advertiserId?: string, maxResults?: number, name?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List targetableRemarketingLists resources
| Argument | Type | Description |
|---|---|---|
| active? | boolean | Select only active or only inactive targetable remarketing lists. |
| advertiserId? | string | Required. Select only targetable remarketing lists targetable by these advertisers. |
| maxResults? | number | Maximum number of results to return. |
| name? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
targetingtemplates.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. |
| advertiserId? | string | Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. |
| advertiserIdDimensionValue? | object | The name of the dimension. |
| contextualKeywordTargeting? | object | The keyword that can be targeted by ads. |
| dayPartTargeting? | object | Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" |
| geoTargeting? | object | Country code of the country to which this city belongs. |
| id? | string | ID of this targeting template. This is a read-only, auto-generated field. |
| keyValueTargetingExpression? | object | Keyword expression being targeted by the ad. |
| languageTargeting? | object | Language ID of this language. This is the ID used for targeting and generating reports. |
| listTargetingExpression? | object | Expression describing which lists are being targeted by the ad. |
| name? | string | Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. |
| subaccountId? | string | Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. |
| technologyTargeting? | object | ID referring to this grouping of browser and version numbers. This is the ID used for targeting. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a targetingTemplates
fn get(identifier: string)
Get a targetingTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the targetingTemplates |
fn update()
Update targetingTemplates attributes
fn sync()
Sync targetingTemplates state from GCP
fn list(advertiserId?: string, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, maxPages?: number)
List targetingTemplates resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | Select only targeting templates with this advertiser ID. |
| ids? | string | Select only targeting templates with these IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
tvcampaigndetails.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a tvCampaignDetails
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the tvCampaignDetails |
fn sync()
Sync tvCampaignDetails state from GCP
tvcampaignsummaries.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a tvCampaignSummaries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tvCampaignSummaries |
fn sync()
Sync tvCampaignSummaries state from GCP
fn list(accountId?: string, countryDartId?: string, name?: string, tvDataProvider?: string, maxPages?: number)
List tvCampaignSummaries resources
| Argument | Type | Description |
|---|---|---|
| accountId? | string | Required. Account ID associated with this request. |
| countryDartId? | string | Optional. Country Dart ID. If not specified, defaults to 256 (US). |
| name? | string | Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. |
| tvDataProvider? | string | Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
userprofiles.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a userProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userProfiles |
fn sync()
Sync userProfiles state from GCP
fn list(maxPages?: number)
List userProfiles resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
userrolepermissiongroups.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a userRolePermissionGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the userRolePermissionGroups |
fn sync()
Sync userRolePermissionGroups state from GCP
fn list(maxPages?: number)
List userRolePermissionGroups resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
userrolepermissions.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a userRolePermissions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the userRolePermissions |
fn sync()
Sync userRolePermissions state from GCP
fn list(ids?: string, maxPages?: number)
List userRolePermissions resources
| Argument | Type | Description |
|---|---|---|
| ids? | string | Select only user role permissions with these IDs. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
userroles.tsv2026.06.08.1
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. |
| accountId? | string | Account ID of this user role. This is a read-only field that can be left blank. |
| defaultUserRole? | boolean | Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. |
| id? | string | ID of this user role. This is a read-only, auto-generated field. |
| name? | string | Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. |
| parentUserRoleId? | string | ID of the user role that this user role is based on or copied from. This is a required field. |
| permissions? | array | Levels of availability for a user role permission. |
| subaccountId? | string | Subaccount ID of this user role. This is a read-only field that can be left blank. |
| profileId | string | User profile ID associated with this request. |
fn create()
Create a userRoles
fn get(identifier: string)
Get a userRoles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the userRoles |
fn update()
Update userRoles attributes
fn delete(identifier: string)
Delete the userRoles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the userRoles |
fn sync()
Sync userRoles state from GCP
fn list(accountUserRoleOnly?: boolean, ids?: string, maxResults?: number, searchString?: string, sortField?: string, sortOrder?: string, subaccountId?: string, maxPages?: number)
List userRoles resources
| Argument | Type | Description |
|---|---|---|
| accountUserRoleOnly? | boolean | Select only account level user roles not associated with any specific subaccount. |
| ids? | string | Select only user roles with the specified IDs. |
| maxResults? | number | Maximum number of results to return. |
| searchString? | string | Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". |
| sortField? | string | Field by which to sort the list. |
| sortOrder? | string | Order of sorted results. |
| subaccountId? | string | Select only user roles that belong to this subaccount. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
videoformats.tsv2026.06.08.1
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. |
fn get(identifier: string)
Get a videoFormats
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the videoFormats |
fn sync()
Sync videoFormats state from GCP
fn list(maxPages?: number)
List videoFormats resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
03Previous Versions
2026.06.08.2Jun 8, 2026
- Updated: accountactiveadsummaries, accountpermissiongroups, accountpermissions, accountuserprofiles, accounts, ads, advertisergroups, advertiserinvoices, advertiserlandingpages, advertisers, billingassignments, billingprofiles, billingrates, browsers, campaigncreativeassociations, campaigns, changelogs, cities, connectiontypes, contentcategories, countries, creativefieldvalues, creativefields, creativegroups, creatives, directorysites, dynamicfeeds, dynamicprofiles, dynamictargetingkeys, eventtags, files, floodlightactivities, floodlightactivitygroups, floodlightconfigurations, languages, metros, mobileapps, mobilecarriers, operatingsystemversions, operatingsystems, placementgroups, placementstrategies, placements, platformtypes, postalcodes, regions, remarketinglistshares, remarketinglists, reports, reports_files, sites, sizes, studiocreatives, subaccounts, targetableremarketinglists, targetingtemplates, tvcampaigndetails, tvcampaignsummaries, userprofiles, userrolepermissiongroups, userrolepermissions, userroles, videoformats, inventoryitems, orders, projects
2026.06.07.1Jun 7, 2026
- Updated: accountactiveadsummaries, accountpermissiongroups, accountpermissions, accountuserprofiles, accounts, ads, advertisergroups, advertiserinvoices, advertiserlandingpages, advertisers, billingassignments, billingprofiles, billingrates, browsers, campaigncreativeassociations, campaigns, changelogs, cities, connectiontypes, contentcategories, countries, creativefieldvalues, creativefields, creativegroups, creatives, directorysites, dynamicfeeds, dynamicprofiles, dynamictargetingkeys, eventtags, files, floodlightactivities, floodlightactivitygroups, floodlightconfigurations, languages, metros, mobileapps, mobilecarriers, operatingsystemversions, operatingsystems, placementgroups, placementstrategies, placements, platformtypes, postalcodes, regions, remarketinglistshares, remarketinglists, reports, reports_files, sites, sizes, studiocreatives, subaccounts, targetableremarketinglists, targetingtemplates, tvcampaigndetails, tvcampaignsummaries, userprofiles, userrolepermissiongroups, userrolepermissions, userroles, videoformats, inventoryitems, orders, projects
2026.06.05.1Jun 5, 2026
- Added: inventoryitems, orders, projects
2026.05.27.1May 28, 2026
- Updated: floodlightactivities
2026.05.26.1May 26, 2026
- Updated: creatives
2026.05.25.2May 25, 2026
- Updated: accountpermissiongroups, accountpermissions, billingassignments, billingrates, browsers, connectiontypes, countries, languages, metros, mobilecarriers, operatingsystemversions, operatingsystems, platformtypes, postalcodes, regions, userprofiles, userrolepermissiongroups, videoformats
Modified 1 models
2026.05.24.1May 24, 2026
- Updated: accountactiveadsummaries, accountpermissiongroups, accountpermissions, accountuserprofiles, accounts, ads, advertisergroups, advertiserinvoices, advertiserlandingpages, advertisers, billingassignments, billingprofiles, billingrates, browsers, campaigncreativeassociations, campaigns, changelogs, cities, connectiontypes, contentcategories, countries, creativefieldvalues, creativefields, creativegroups, creatives, directorysites, dynamicfeeds, dynamicprofiles, dynamictargetingkeys, eventtags, files, floodlightactivities, floodlightactivitygroups, floodlightconfigurations, languages, metros, mobileapps, mobilecarriers, operatingsystemversions, operatingsystems, placementgroups, placementstrategies, placements, platformtypes, postalcodes, regions, remarketinglistshares, remarketinglists, reports, reports_files, sites, sizes, studiocreatives, subaccounts, targetableremarketinglists, targetingtemplates, tvcampaigndetails, tvcampaignsummaries, userprofiles, userrolepermissiongroups, userrolepermissions, userroles, videoformats
2026.05.21.2May 21, 2026
- Updated: accountactiveadsummaries, accountpermissiongroups, accountpermissions, accountuserprofiles, accounts, ads, advertisergroups, advertiserinvoices, advertiserlandingpages, advertisers, billingassignments, billingprofiles, billingrates, browsers, campaigncreativeassociations, campaigns, changelogs, cities, connectiontypes, contentcategories, countries, creativefieldvalues, creativefields, creativegroups, creatives, directorysites, dynamicfeeds, dynamicprofiles, dynamictargetingkeys, eventtags, files, floodlightactivities, floodlightactivitygroups, floodlightconfigurations, languages, metros, mobileapps, mobilecarriers, operatingsystemversions, operatingsystems, placementgroups, placementstrategies, placements, platformtypes, postalcodes, regions, remarketinglistshares, remarketinglists, reports, reports_files, sites, sizes, studiocreatives, subaccounts, targetableremarketinglists, targetingtemplates, tvcampaigndetails, tvcampaignsummaries, userprofiles, userrolepermissiongroups, userrolepermissions, userroles, videoformats
2026.05.21.1May 21, 2026
2026.05.20.1May 20, 2026
- Updated: creatives
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.14.1May 14, 2026
- Updated: creatives
Modified 1 models
2026.04.23.1Apr 23, 2026
Modified 1 models
2026.04.04.1Apr 4, 2026
- Updated: ads, campaigns, creatives, dynamicfeeds, dynamicprofiles, remarketinglists
2026.04.03.3Apr 3, 2026
- Updated: accountactiveadsummaries, accountpermissiongroups, accountpermissions, accountuserprofiles, accounts, ads, advertisergroups, advertiserinvoices, advertiserlandingpages, advertisers, billingassignments, billingprofiles, billingrates, browsers, campaigncreativeassociations, campaigns, changelogs, cities, connectiontypes, contentcategories, countries, creativefieldvalues, creativefields, creativegroups, creatives, directorysites, dynamicfeeds, dynamicprofiles, dynamictargetingkeys, eventtags, files, floodlightactivities, floodlightactivitygroups, floodlightconfigurations, languages, metros, mobileapps, mobilecarriers, operatingsystemversions, operatingsystems, placementgroups, placementstrategies, placements, platformtypes, postalcodes, regions, remarketinglistshares, remarketinglists, reports, reports_files, sites, sizes, studiocreatives, subaccounts, targetableremarketinglists, targetingtemplates, tvcampaigndetails, tvcampaignsummaries, userprofiles, userrolepermissiongroups, userrolepermissions, userroles, videoformats
2026.04.03.1Apr 3, 2026
- Updated: accountactiveadsummaries, accountpermissiongroups, accountpermissions, accountuserprofiles, accounts, ads, advertisergroups, advertiserinvoices, advertiserlandingpages, advertisers, billingassignments, billingprofiles, billingrates, browsers, campaigncreativeassociations, campaigns, changelogs, cities, connectiontypes, contentcategories, countries, creativefieldvalues, creativefields, creativegroups, creatives, directorysites, dynamicfeeds, dynamicprofiles, dynamictargetingkeys, eventtags, files, floodlightactivities, floodlightactivitygroups, floodlightconfigurations, languages, metros, mobileapps, mobilecarriers, operatingsystemversions, operatingsystems, placementgroups, placementstrategies, placements, platformtypes, postalcodes, regions, remarketinglistshares, remarketinglists, reports, reports_files, sites, sizes, studiocreatives, subaccounts, targetableremarketinglists, targetingtemplates, tvcampaigndetails, tvcampaignsummaries, userprofiles, userrolepermissiongroups, userrolepermissions, userroles, videoformats
2026.04.02.2Apr 2, 2026
Modified 1 models
04Stats
A
100 / 100
Downloads
1
Archive size
650.3 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
05Platforms
06Labels