Skip to main content

@swamp/gcp/dfareporting

v2026.04.23.1

Google Cloud dfareporting infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-clouddfareportingcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/dfareporting

studiocreatives.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
assetIds?arrayList of assets associated with this studio creative. It is a required field on insertion.
backupImageAssetId?stringBackup image asset ID of this studio creative. It is a required field on insertion.
createdInfo?objectTimestamp of the last change in milliseconds since epoch.
dimension?objectHeight of the studio creative.
dynamicProfileId?stringDynamic profile ID of this studio creative.
format?enumFormat of this studio creative. This is a required field on insertion.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
name?stringIdentifier. Name of this studio creative. This is a required field on insertion.
studioAccountId?stringStudio account ID of this creative. This field, if left unset, will be auto-populated.
studioAdvertiserId?stringStudio advertiser ID of this studio creative. This is a required field on insertion.
studioCampaignId?stringStudio campaign ID of this studio creative. This is a required field on insertion.
createCreate a studioCreatives
getGet a studioCreatives
ArgumentTypeDescription
identifierstringThe name of the studioCreatives
syncSync studioCreatives state from GCP
publishpublish
videoformats.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a videoFormats
ArgumentTypeDescription
identifierstringThe id of the videoFormats
syncSync videoFormats state from GCP
billingprofiles.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
consolidatedInvoice?booleanConsolidated invoice option for this billing profile. Used to get a single, consolidated invoice across the chosen invoice level.
countryCode?stringCountry code of this billing profile.This is a read-only field.
currencyCode?stringBilling currency code in ISO 4217 format.This is a read-only field.
id?stringID of this billing profile. This is a read-only, auto-generated field.
invoiceLevel?enumInvoice level for this billing profile. Used to group fees into separate invoices by account, advertiser, or campaign.
isDefault?booleanTrue if the billing profile is the account default profile. This is a read-only field.
kind?stringIdentifies what kind of resource this is. Value: the fixed string "dfareporting#billingProfile".
name?stringName 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?stringThe ID of the payment account the billing profile belongs to. This is a read-only field.
paymentsCustomerId?stringThe ID of the payment customer the billing profile belongs to. This is a read-only field.
purchaseOrder?stringPurchase order (PO) for this billing profile. This PO number is used in the invoices for all of the advertisers in this billing profile.
secondaryPaymentsCustomerId?stringThe ID of the secondary payment customer the billing profile belongs to. This is a read-only field.
status?enumStatus of this billing profile.This is a read-only field.
getGet a billingProfiles
ArgumentTypeDescription
identifierstringThe id of the billingProfiles
updateUpdate billingProfiles attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
syncSync billingProfiles state from GCP
operatingsystems.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a operatingSystems
ArgumentTypeDescription
identifierstringThe name of the operatingSystems
syncSync operatingSystems state from GCP
tvcampaignsummaries.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a tvCampaignSummaries
ArgumentTypeDescription
identifierstringThe name of the tvCampaignSummaries
syncSync tvCampaignSummaries state from GCP
creativegroups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this creative group. This is a read-only field that can be left blank.
advertiserId?stringAdvertiser ID of this creative group. This is a required field on insertion.
advertiserIdDimensionValue?objectThe name of the dimension.
groupNumber?numberSubgroup 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?stringID of this creative group. This is a read-only, auto-generated field.
name?stringName 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?stringSubaccount ID of this creative group. This is a read-only field that can be left blank.
profileIdstringUser profile ID associated with this request.
createCreate a creativeGroups
getGet a creativeGroups
ArgumentTypeDescription
identifierstringThe id of the creativeGroups
updateUpdate creativeGroups attributes
syncSync creativeGroups state from GCP
connectiontypes.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a connectionTypes
ArgumentTypeDescription
identifierstringThe id of the connectionTypes
syncSync connectionTypes state from GCP
subaccounts.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringID of the account that contains this subaccount. This is a read-only field that can be left blank.
availablePermissionIds?arrayIDs of the available user role permissions for this subaccount.
id?stringID of this subaccount. This is a read-only, auto-generated field.
name?stringName of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
profileIdstringUser profile ID associated with this request.
createCreate a subaccounts
getGet a subaccounts
ArgumentTypeDescription
identifierstringThe id of the subaccounts
updateUpdate subaccounts attributes
syncSync subaccounts state from GCP
billingrates.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a billingRates
ArgumentTypeDescription
identifierstringThe name of the billingRates
syncSync billingRates state from GCP
floodlightactivities.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this floodlight activity. This is a read-only field that can be left blank.
advertiserId?stringAdvertiser 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?objectThe name of the dimension.
attributionEnabled?booleanWhether the activity is enabled for attribution.
cacheBustingType?enumCode type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
conversionCategory?enumRequired. The conversion category of the activity.
countingMethod?enumCounting method for conversions for this floodlight activity. This is a required field.
defaultTags?arrayID of this dynamic tag. This is a read-only, auto-generated field.
expectedUrl?stringURL where this tag will be deployed. If specified, must be less than 256 characters long.
floodlightActivityGroupId?stringFloodlight activity group ID of this floodlight activity. This is a required field.
floodlightActivityGroupName?stringName of the associated floodlight activity group. This is a read-only field.
floodlightActivityGroupTagString?stringTag string of the associated floodlight activity group. This is a read-only field.
floodlightActivityGroupType?enumType of the associated floodlight activity group. This is a read-only field.
floodlightConfigurationId?stringFloodlight 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?objectThe name of the dimension.
floodlightTagType?enumThe type of Floodlight tag this activity will generate. This is a required field.
id?stringID of this floodlight activity. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
name?stringName of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
notes?stringGeneral notes or implementation instructions for the tag.
publisherTags?arrayWhether this tag is applicable only for click-throughs.
secure?booleanWhether this tag should use SSL.
sslCompliant?booleanWhether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
sslRequired?booleanWhether this floodlight activity must be SSL-compliant.
status?enumThe 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?stringSubaccount ID of this floodlight activity. This is a read-only field that can be left blank.
tagFormat?enumTag format type for the floodlight activity. If left blank, the tag format will default to HTML.
tagString?stringValue 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?arrayList 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.
profileIdstringUser profile ID associated with this request.
createCreate a floodlightActivities
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a floodlightActivities
ArgumentTypeDescription
identifierstringThe id of the floodlightActivities
updateUpdate floodlightActivities attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the floodlightActivities
ArgumentTypeDescription
identifierstringThe id of the floodlightActivities
syncSync floodlightActivities state from GCP
generatetaggeneratetag
creativefields.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this creative field. This is a read-only field that can be left blank.
advertiserId?stringAdvertiser ID of this creative field. This is a required field on insertion.
advertiserIdDimensionValue?objectThe name of the dimension.
id?stringID of this creative field. This is a read-only, auto-generated field.
name?stringName 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?stringSubaccount ID of this creative field. This is a read-only field that can be left blank.
profileIdstringUser profile ID associated with this request.
createCreate a creativeFields
getGet a creativeFields
ArgumentTypeDescription
identifierstringThe id of the creativeFields
updateUpdate creativeFields attributes
deleteDelete the creativeFields
ArgumentTypeDescription
identifierstringThe id of the creativeFields
syncSync creativeFields state from GCP
regions.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a regions
ArgumentTypeDescription
identifierstringThe name of the regions
syncSync regions state from GCP
dynamicprofiles.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
active?objectOptional. Dynamic feed ID associated with dynamic profile version.
archiveStatus?enumOptional. Archive status of this dynamic profile.
createInfo?objectTimestamp of the last change in milliseconds since epoch.
description?stringOptional. Description of this dynamic profile.
draft?objectOptional. Dynamic feed ID associated with dynamic profile version.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
name?stringRequired. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
status?enumOptional. Status of this dynamic profile.
studioAdvertiserId?stringRequired. Advertiser ID of this dynamic profile. This is a required field on insertion.
createCreate a dynamicProfiles
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a dynamicProfiles
ArgumentTypeDescription
identifierstringThe name of the dynamicProfiles
updateUpdate dynamicProfiles attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
syncSync dynamicProfiles state from GCP
generate_codegenerate code
publishpublish
floodlightconfigurations.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this floodlight configuration. This is a read-only field that can be left blank.
advertiserId?stringAdvertiser ID of the parent advertiser of this floodlight configuration.
advertiserIdDimensionValue?objectThe name of the dimension.
analyticsDataSharingEnabled?booleanWhether advertiser data is shared with Google Analytics.
customViewabilityMetric?objectWhether the video must be audible to count an impression.
exposureToConversionEnabled?booleanWhether 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?stringID of this floodlight configuration. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
inAppAttributionTrackingEnabled?booleanWhether in-app attribution tracking is enabled.
kind?stringIdentifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
lookbackConfiguration?objectLookback 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?enumTypes of attribution options for natural search conversions.
omnitureSettings?objectWhether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
subaccountId?stringSubaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
tagSettings?objectWhether dynamic floodlight tags are enabled.
thirdPartyAuthenticationTokens?arrayName of the third-party authentication token.
userDefinedVariableConfigurations?arrayData type for the variable. This is a required field.
getGet a floodlightConfigurations
ArgumentTypeDescription
identifierstringThe id of the floodlightConfigurations
updateUpdate floodlightConfigurations attributes
syncSync floodlightConfigurations state from GCP
userrolepermissions.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a userRolePermissions
ArgumentTypeDescription
identifierstringThe id of the userRolePermissions
syncSync userRolePermissions state from GCP
browsers.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a browsers
ArgumentTypeDescription
identifierstringThe name of the browsers
syncSync browsers state from GCP
placementstrategies.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this placement strategy.This is a read-only field that can be left blank.
id?stringID of this placement strategy. This is a read-only, auto-generated field.
name?stringName 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.
profileIdstringUser profile ID associated with this request.
createCreate a placementStrategies
getGet a placementStrategies
ArgumentTypeDescription
identifierstringThe id of the placementStrategies
updateUpdate placementStrategies attributes
deleteDelete the placementStrategies
ArgumentTypeDescription
identifierstringThe id of the placementStrategies
syncSync placementStrategies state from GCP
remarketinglistshares.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
kind?stringIdentifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
remarketingListId?stringRemarketing list ID. This is a read-only, auto-generated field.
sharedAccountIds?arrayAccounts that the remarketing list is shared with.
sharedAdvertiserIds?arrayAdvertisers that the remarketing list is shared with.
getGet a remarketingListShares
ArgumentTypeDescription
identifierstringThe name of the remarketingListShares
updateUpdate remarketingListShares attributes
syncSync remarketingListShares state from GCP
metros.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a metros
ArgumentTypeDescription
identifierstringThe name of the metros
syncSync metros state from GCP
placements.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this placement. This field can be left blank.
activeStatus?enumWhether this placement is active, inactive, archived or permanently archived.
adBlockingOptOut?booleanWhether 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?stringOptional. 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?arrayHeight of this size. Acceptable values are 0 to 32767, inclusive.
advertiserId?stringAdvertiser ID of this placement. This field can be left blank.
advertiserIdDimensionValue?objectThe name of the dimension.
allowOnYoutube?booleanOptional. Whether the placement is enabled for YouTube integration.
campaignId?stringCampaign ID of this placement. This field is a required field on insertion.
campaignIdDimensionValue?objectThe name of the dimension.
comment?stringComments for this placement.
compatibility?enumPlacement 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?stringID of the content category assigned to this placement.
conversionDomainOverride?object
createInfo?objectTimestamp of the last change in milliseconds since epoch.
directorySiteId?stringDirectory 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?objectThe name of the dimension.
externalId?stringExternal ID for this placement.
id?stringID of this placement. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
keyName?stringKey name of this placement. This is a read-only, auto-generated field.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
lookbackConfiguration?objectLookback 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?stringName of this placement.This is a required field and must be less than or equal to 512 characters long.
partnerWrappingData?objectPlacement wrapping status.
paymentApproved?booleanWhether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
paymentSource?enumPayment source for this placement. This is a required field that is read-only after insertion.
placementGroupId?stringID of this placement's group, if applicable.
placementGroupIdDimensionValue?objectThe name of the dimension.
placementStrategyId?stringID of the placement strategy assigned to this placement.
pricingSchedule?objectPlacement cap cost option.
primary?booleanWhether 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?objectTimestamp of the last change in milliseconds since epoch.
siteId?stringSite 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?objectThe name of the dimension.
siteServed?booleanOptional. 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?objectHeight of this size. Acceptable values are 0 to 32767, inclusive.
sslRequired?booleanWhether creatives assigned to this placement must be SSL-compliant.
status?enumThird-party placement status.
subaccountId?stringSubaccount ID of this placement. This field can be left blank.
tagFormats?arrayTag 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?objectAdditional 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?booleanWhether 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?objectWhether companions are disabled for this placement.
vpaidAdapterChoice?enumVPAID 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?booleanWhether this placement opts out of tag wrapping.
youtubeSettings?objectOptional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
profileIdstringUser profile ID associated with this request.
createCreate a placements
getGet a placements
ArgumentTypeDescription
identifierstringThe id of the placements
updateUpdate placements attributes
syncSync placements state from GCP
generatetagsgeneratetags
directorysites.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
id?stringID of this directory site. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
inpageTagFormats?arrayTag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"
interstitialTagFormats?arrayTag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"
name?stringName of this directory site.
settings?objectWhether this directory site has disabled active view creatives.
url?stringURL of this directory site.
profileIdstringUser profile ID associated with this request.
createCreate a directorySites
getGet a directorySites
ArgumentTypeDescription
identifierstringThe id of the directorySites
syncSync directorySites state from GCP
accountpermissions.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a accountPermissions
ArgumentTypeDescription
identifierstringThe id of the accountPermissions
syncSync accountPermissions state from GCP
tvcampaigndetails.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a tvCampaignDetails
ArgumentTypeDescription
identifierstringThe id of the tvCampaignDetails
syncSync tvCampaignDetails state from GCP
userrolepermissiongroups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a userRolePermissionGroups
ArgumentTypeDescription
identifierstringThe id of the userRolePermissionGroups
syncSync userRolePermissionGroups state from GCP
billingassignments.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accountId?stringID of the account associated with the billing assignment.This is a read-only, auto-generated field.
advertiserId?stringID of the advertiser associated with the billing assignment.Wildcard (*) means this assignment is not limited to a single advertiser
campaignId?stringID of the campaign associated with the billing assignment. Wildcard (*) means this assignment is not limited to a single campaign
subaccountId?stringID 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.
profileIdstringUser profile ID associated with this request.
billingProfileIdstringBilling profile ID of this billing assignment.
createCreate a billingAssignments
getGet a billingAssignments
ArgumentTypeDescription
identifierstringThe name of the billingAssignments
syncSync billingAssignments state from GCP
sizes.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
height?numberHeight of this size. Acceptable values are 0 to 32767, inclusive.
iab?booleanIAB standard size. This is a read-only, auto-generated field.
id?stringID of this size. This is a read-only, auto-generated field.
width?numberWidth of this size. Acceptable values are 0 to 32767, inclusive.
profileIdstringUser profile ID associated with this request.
createCreate a sizes
getGet a sizes
ArgumentTypeDescription
identifierstringThe id of the sizes
syncSync sizes state from GCP
userroles.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this user role. This is a read-only field that can be left blank.
defaultUserRole?booleanWhether 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?stringID of this user role. This is a read-only, auto-generated field.
name?stringName 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?stringID of the user role that this user role is based on or copied from. This is a required field.
permissions?arrayLevels of availability for a user role permission.
subaccountId?stringSubaccount ID of this user role. This is a read-only field that can be left blank.
profileIdstringUser profile ID associated with this request.
createCreate a userRoles
getGet a userRoles
ArgumentTypeDescription
identifierstringThe id of the userRoles
updateUpdate userRoles attributes
deleteDelete the userRoles
ArgumentTypeDescription
identifierstringThe id of the userRoles
syncSync userRoles state from GCP
dynamictargetingkeys.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
name?stringName 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?stringID of the object of this dynamic targeting key. This is a required field.
objectType?enumType of the object of this dynamic targeting key. This is a required field.
profileIdstringUser profile ID associated with this request.
createCreate a dynamicTargetingKeys
getGet a dynamicTargetingKeys
ArgumentTypeDescription
identifierstringThe name of the dynamicTargetingKeys
deleteDelete the dynamicTargetingKeys
ArgumentTypeDescription
identifierstringThe name of the dynamicTargetingKeys
syncSync dynamicTargetingKeys state from GCP
eventtags.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this event tag. This is a read-only field that can be left blank.
advertiserId?stringAdvertiser ID of this event tag. This field or the campaignId field is required on insertion.
advertiserIdDimensionValue?objectThe name of the dimension.
campaignId?stringCampaign ID of this event tag. This field or the advertiserId field is required on insertion.
campaignIdDimensionValue?objectThe name of the dimension.
enabledByDefault?booleanWhether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
excludeFromAdxRequests?booleanWhether 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?stringID of this event tag. This is a read-only, auto-generated field.
name?stringName of this event tag. This is a required field and must be less than 256 characters long.
siteFilterType?enumSite filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
siteIds?arrayFilter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
sslCompliant?booleanWhether this tag is SSL-compliant or not. This is a read-only field.
status?enumStatus of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
subaccountId?stringSubaccount ID of this event tag. This is a read-only field that can be left blank.
type?enumEvent 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?stringPayload 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?numberNumber 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.
profileIdstringUser profile ID associated with this request.
createCreate a eventTags
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a eventTags
ArgumentTypeDescription
identifierstringThe id of the eventTags
updateUpdate eventTags attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the eventTags
ArgumentTypeDescription
identifierstringThe id of the eventTags
syncSync eventTags state from GCP
countries.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a countries
ArgumentTypeDescription
identifierstringThe name of the countries
syncSync countries state from GCP
targetingtemplates.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
advertiserId?stringAdvertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
advertiserIdDimensionValue?objectThe name of the dimension.
contextualKeywordTargeting?objectThe keyword that can be targeted by ads.
dayPartTargeting?objectDays of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
geoTargeting?objectCountry code of the country to which this city belongs.
id?stringID of this targeting template. This is a read-only, auto-generated field.
keyValueTargetingExpression?objectKeyword expression being targeted by the ad.
languageTargeting?objectLanguage ID of this language. This is the ID used for targeting and generating reports.
listTargetingExpression?objectExpression describing which lists are being targeted by the ad.
name?stringName of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
subaccountId?stringSubaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
technologyTargeting?objectID referring to this grouping of browser and version numbers. This is the ID used for targeting.
profileIdstringUser profile ID associated with this request.
createCreate a targetingTemplates
getGet a targetingTemplates
ArgumentTypeDescription
identifierstringThe id of the targetingTemplates
updateUpdate targetingTemplates attributes
syncSync targetingTemplates state from GCP
reports_files.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a files
ArgumentTypeDescription
identifierstringThe name of the files
syncSync files state from GCP
advertiserlandingpages.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
advertiserId?stringAdvertiser ID of this landing page. This is a required field.
archived?booleanWhether this landing page has been archived.
deepLinks?arrayThe URL of the mobile app being linked to.
id?stringID of this landing page. This is a read-only, auto-generated field.
name?stringName of this landing page. This is a required field. It must be less than 256 characters long.
url?stringURL of this landing page. This is a required field.
profileIdstringUser profile ID associated with this request.
createCreate a advertiserLandingPages
getGet a advertiserLandingPages
ArgumentTypeDescription
identifierstringThe id of the advertiserLandingPages
updateUpdate advertiserLandingPages attributes
syncSync advertiserLandingPages state from GCP
targetableremarketinglists.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a targetableRemarketingLists
ArgumentTypeDescription
identifierstringThe id of the targetableRemarketingLists
syncSync targetableRemarketingLists state from GCP
platformtypes.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a platformTypes
ArgumentTypeDescription
identifierstringThe id of the platformTypes
syncSync platformTypes state from GCP
creativefieldvalues.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
id?stringID of this creative field value. This is a read-only, auto-generated field.
value?stringValue of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
profileIdstringUser profile ID associated with this request.
creativeFieldIdstringCreative field ID for this creative field value.
createCreate a creativeFieldValues
getGet a creativeFieldValues
ArgumentTypeDescription
identifierstringThe id of the creativeFieldValues
updateUpdate creativeFieldValues attributes
deleteDelete the creativeFieldValues
ArgumentTypeDescription
identifierstringThe id of the creativeFieldValues
syncSync creativeFieldValues state from GCP
creatives.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount 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?booleanWhether the creative is active. Applicable to all creative types.
adParameters?stringAd parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
adTagKeys?arrayKeywords 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?arrayHeight of this size. Acceptable values are 0 to 32767, inclusive.
advertiserId?stringRequired. Advertiser ID of this creative. This is a required field. Applicable to all creative types.
allowScriptAccess?booleanWhether 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?booleanWhether the creative is archived. Applicable to all creative types.
artworkType?enumType 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?enumSource application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
authoringTool?enumAuthoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
autoAdvanceImages?booleanWhether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
backgroundColor?stringThe 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?objectRead-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?arrayList 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?stringReporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
backupImageTargetWindow?objectUser-entered value.
clickTags?arrayRead-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?stringIndustry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
companionCreatives?arrayList 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?arrayCompatibilities 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?booleanWhether 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?arrayUnique ID of this event used by Reporting and Data Transfer. This is a read-only field.
creativeAssets?arrayWhether 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?arrayID of the creative field.
customKeyValues?arrayCustom 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?arrayUnique ID of this event used by Reporting and Data Transfer. This is a read-only field.
fsCommand?objectDistance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
htmlCode?stringHTML 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?booleanWhether 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?stringID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
idDimensionValue?objectThe name of the dimension.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
latestTraffickedCreativeId?stringLatest 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?stringDescription of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
mediaDuration?numberCreative 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?stringRequired. Name of the creative. This must be less than 256 characters long. Applicable to all creative types.
obaIcon?objectURL to redirect to when an OBA icon is clicked.
overrideCss?stringOverride CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
progressOffset?objectDuration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
redirectUrl?stringURL 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?stringID of current rendering version. This is a read-only field. Applicable to all creative types.
renderingIdDimensionValue?objectThe name of the dimension.
requiredFlashPluginVersion?stringThe 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?numberThe 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?objectHeight of this size. Acceptable values are 0 to 32767, inclusive.
skipOffset?objectDuration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
skippable?booleanWhether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
sslCompliant?booleanWhether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
sslOverride?booleanWhether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
studioAdvertiserId?stringStudio 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?stringStudio 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?stringStudio 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?stringSubaccount 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?stringThird-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
thirdPartyRichMediaImpressionsUrl?stringThird-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
thirdPartyUrls?arrayThird-party URL type for in-stream video and in-stream audio creatives.
timerCustomEvents?arrayUnique ID of this event used by Reporting and Data Transfer. This is a read-only field.
totalFileSize?stringCombined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
type?enumRequired. 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?objectRegistry used for the Ad ID value.
version?numberThe 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.
profileIdstringUser profile ID associated with this request.
createCreate a creatives
getGet a creatives
ArgumentTypeDescription
identifierstringThe id of the creatives
updateUpdate creatives attributes
syncSync creatives state from GCP
floodlightactivitygroups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this floodlight activity group. This is a read-only field that can be left blank.
advertiserId?stringAdvertiser 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?objectThe name of the dimension.
floodlightConfigurationId?stringFloodlight configuration ID of this floodlight activity group. This is a required field.
floodlightConfigurationIdDimensionValue?objectThe name of the dimension.
id?stringID of this floodlight activity group. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
name?stringName of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
subaccountId?stringSubaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
tagString?stringValue 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?enumType of the floodlight activity group. This is a required field that is read-only after insertion.
profileIdstringUser profile ID associated with this request.
createCreate a floodlightActivityGroups
getGet a floodlightActivityGroups
ArgumentTypeDescription
identifierstringThe id of the floodlightActivityGroups
updateUpdate floodlightActivityGroups attributes
syncSync floodlightActivityGroups state from GCP
reports.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringThe account ID to which this report belongs.
criteria?objectThe name of the dimension.
crossMediaReachCriteria?objectThe kind of resource this is, in this case dfareporting#dateRange.
delivery?objectWhether the report should be emailed to the report owner.
fileName?stringThe filename used when generating report files for this report.
floodlightCriteria?objectThe name of the dimension.
format?enumThe 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?stringThe unique ID identifying this report resource.
lastModifiedTime?stringThe timestamp (in milliseconds since epoch) of when this report was last modified.
name?stringThe name of the report.
ownerProfileId?stringThe user profile id of the owner of this report.
pathToConversionCriteria?objectThe name of the dimension.
reachCriteria?objectThe name of the dimension.
schedule?objectWhether the schedule is active or not. Must be set to either true or false.
subAccountId?stringThe subaccount ID to which this report belongs if applicable.
type?enumThe type of the report.
profileIdstringThe Campaign Manager 360 user profile ID.
createCreate a reports
getGet a reports
ArgumentTypeDescription
identifierstringThe name of the reports
updateUpdate reports attributes
deleteDelete the reports
ArgumentTypeDescription
identifierstringThe name of the reports
syncSync reports state from GCP
runrun
accounts.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountPermissionIds?arrayAccount permissions assigned to this account.
accountProfile?enumProfile for this account. This is a read-only field that can be left blank.
active?booleanWhether this account is active.
activeAdsLimitTier?enumMaximum number of active ads allowed for this account.
activeViewOptOut?booleanWhether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
availablePermissionIds?arrayUser role permissions available to the user roles of this account.
countryId?stringID of the country associated with this account.
currencyId?stringID 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?stringDefault placement dimensions for this account.
description?stringDescription of this account.
id?stringID of this account. This is a read-only, auto-generated field.
kind?stringIdentifies what kind of resource this is. Value: the fixed string "dfareporting#account".
locale?stringLocale 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?stringMaximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
name?stringName of this account. This is a required field, and must be less than 128 characters long and be globally unique.
nielsenOcrEnabled?booleanWhether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
reportsConfiguration?objectWhether 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?booleanShare Path to Conversion reports with Twitter.
teaserSizeLimit?stringFile size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
getGet a accounts
ArgumentTypeDescription
identifierstringThe id of the accounts
updateUpdate accounts attributes
syncSync accounts state from GCP
advertisergroups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this advertiser group. This is a read-only field that can be left blank.
id?stringID of this advertiser group. This is a read-only, auto-generated field.
name?stringName 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.
profileIdstringUser profile ID associated with this request.
createCreate a advertiserGroups
getGet a advertiserGroups
ArgumentTypeDescription
identifierstringThe id of the advertiserGroups
updateUpdate advertiserGroups attributes
deleteDelete the advertiserGroups
ArgumentTypeDescription
identifierstringThe id of the advertiserGroups
syncSync advertiserGroups state from GCP
files.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a files
ArgumentTypeDescription
identifierstringThe name of the files
syncSync files state from GCP
postalcodes.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a postalCodes
ArgumentTypeDescription
identifierstringThe name of the postalCodes
syncSync postalCodes state from GCP
remarketinglists.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
active?booleanWhether this remarketing list is active.
advertiserId?stringDimension value for the advertiser ID that owns this remarketing list. This is a required field.
advertiserIdDimensionValue?objectThe name of the dimension.
description?stringRemarketing list description.
id?stringRemarketing list ID. This is a read-only, auto-generated field.
lifeSpan?stringNumber of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
listPopulationRule?objectFloodlight activity ID associated with this rule. This field can be left blank.
listSize?stringNumber of users currently in the list. This is a read-only field.
listSource?enumProduct from which this remarketing list was originated.
name?stringName of the remarketing list. This is a required field. Must be no greater than 128 characters long.
subaccountId?stringSubaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
profileIdstringUser profile ID associated with this request.
createCreate a remarketingLists
getGet a remarketingLists
ArgumentTypeDescription
identifierstringThe id of the remarketingLists
updateUpdate remarketingLists attributes
syncSync remarketingLists state from GCP
advertisers.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this advertiser.This is a read-only field that can be left blank.
advertiserGroupId?stringID 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?stringSuffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
defaultClickThroughEventTagId?stringID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
defaultEmail?stringDefault email address used in sender field for tag emails.
euPoliticalAdsDeclaration?enumOptional. Whether the advertiser plans to serve EU political ads.
floodlightConfigurationId?stringFloodlight 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?objectThe name of the dimension.
id?stringID of this advertiser. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
measurementPartnerLink?objectStatus of the partner link.
name?stringName 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?stringOriginal 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?enumStatus of this advertiser.
subaccountId?stringSubaccount ID of this advertiser.This is a read-only field that can be left blank.
suspended?booleanSuspension status of this advertiser.
profileIdstringUser profile ID associated with this request.
createCreate a advertisers
getGet a advertisers
ArgumentTypeDescription
identifierstringThe id of the advertisers
updateUpdate advertisers attributes
syncSync advertisers state from GCP
changelogs.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a changeLogs
ArgumentTypeDescription
identifierstringThe id of the changeLogs
syncSync changeLogs state from GCP
advertiserinvoices.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a advertiserInvoices
ArgumentTypeDescription
identifierstringThe name of the advertiserInvoices
syncSync advertiserInvoices state from GCP
placementgroups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this placement group. This is a read-only field that can be left blank.
activeStatus?enumWhether this placement group is active, inactive, archived or permanently archived.
advertiserId?stringAdvertiser ID of this placement group. This is a required field on insertion.
advertiserIdDimensionValue?objectThe name of the dimension.
campaignId?stringCampaign ID of this placement group. This field is required on insertion.
campaignIdDimensionValue?objectThe name of the dimension.
childPlacementIds?arrayIDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
comment?stringComments for this placement group.
contentCategoryId?stringID of the content category assigned to this placement group.
createInfo?objectTimestamp of the last change in milliseconds since epoch.
directorySiteId?stringDirectory 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?objectThe name of the dimension.
externalId?stringExternal ID for this placement.
id?stringID of this placement group. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
name?stringName of this placement group. This is a required field and must be less than 256 characters long.
placementGroupType?enumType 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?stringID of the placement strategy assigned to this placement group.
pricingSchedule?objectPlacement cap cost option.
primaryPlacementId?stringID 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?objectThe name of the dimension.
siteId?stringSite 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?objectThe name of the dimension.
subaccountId?stringSubaccount ID of this placement group. This is a read-only field that can be left blank.
profileIdstringUser profile ID associated with this request.
createCreate a placementGroups
getGet a placementGroups
ArgumentTypeDescription
identifierstringThe id of the placementGroups
updateUpdate placementGroups attributes
syncSync placementGroups state from GCP
mobileapps.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a mobileApps
ArgumentTypeDescription
identifierstringThe id of the mobileApps
syncSync mobileApps state from GCP
campaigncreativeassociations.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
creativeId?stringID of the creative associated with the campaign. This is a required field.
profileIdstringUser profile ID associated with this request.
campaignIdstringCampaign ID in this association.
createCreate a campaignCreativeAssociations
getGet a campaignCreativeAssociations
ArgumentTypeDescription
identifierstringThe name of the campaignCreativeAssociations
syncSync campaignCreativeAssociations state from GCP
accountpermissiongroups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a accountPermissionGroups
ArgumentTypeDescription
identifierstringThe id of the accountPermissionGroups
syncSync accountPermissionGroups state from GCP
contentcategories.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this content category. This is a read-only field that can be left blank.
id?stringID of this content category. This is a read-only, auto-generated field.
name?stringName 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.
profileIdstringUser profile ID associated with this request.
createCreate a contentCategories
getGet a contentCategories
ArgumentTypeDescription
identifierstringThe id of the contentCategories
updateUpdate contentCategories attributes
deleteDelete the contentCategories
ArgumentTypeDescription
identifierstringThe id of the contentCategories
syncSync contentCategories state from GCP
sites.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this site. This is a read-only field that can be left blank.
adServingPlatformId?stringOptional. 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?booleanWhether this site is approved.
directorySiteId?stringDirectory site associated with this site. This is a required field that is read-only after insertion.
directorySiteIdDimensionValue?objectThe name of the dimension.
id?stringID of this site. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
keyName?stringKey name of this site. This is a read-only, auto-generated field.
name?stringName 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?arrayAddress of this site contact.
siteSettings?objectWhether active view creatives are disabled for this site.
subaccountId?stringSubaccount ID of this site. This is a read-only field that can be left blank.
videoSettings?objectWhether companions are disabled for this site template.
profileIdstringUser profile ID associated with this request.
createCreate a sites
getGet a sites
ArgumentTypeDescription
identifierstringThe id of the sites
updateUpdate sites attributes
syncSync sites state from GCP
campaigns.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this campaign. This is a read-only field that can be left blank.
adBlockingConfiguration?objectWhether 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?arrayID 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?stringAdvertiser group ID of the associated advertiser.
advertiserId?stringAdvertiser ID of this campaign. This is a required field.
advertiserIdDimensionValue?objectThe name of the dimension.
archived?booleanWhether this campaign has been archived.
audienceSegmentGroups?arrayWeight 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?stringBilling invoice code included in the Campaign Manager client billing invoices associated with the campaign.
clickThroughUrlSuffixProperties?objectClick-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
comment?stringArbitrary comments about this campaign. Must be less than 256 characters long.
createInfo?objectTimestamp of the last change in milliseconds since epoch.
creativeGroupIds?arrayList of creative group IDs that are assigned to the campaign.
creativeOptimizationConfiguration?objectID 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?objectID of the click-through event tag to apply to all ads in this entity's scope.
defaultLandingPageId?stringThe default landing page ID for this campaign.
endDate?string
euPoliticalAdsDeclaration?enumOptional. 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?arrayWhether this override is enabled.
externalId?stringExternal ID for this campaign.
id?stringID of this campaign. This is a read-only auto-generated field.
idDimensionValue?objectThe name of the dimension.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
measurementPartnerLink?object.
name?stringName 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?stringSubaccount ID of this campaign. This is a read-only field that can be left blank.
profileIdstringUser profile ID associated with this request.
createCreate a campaigns
getGet a campaigns
ArgumentTypeDescription
identifierstringThe id of the campaigns
updateUpdate campaigns attributes
syncSync campaigns state from GCP
languages.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a languages
ArgumentTypeDescription
identifierstringThe name of the languages
syncSync languages state from GCP
accountuserprofiles.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of the user profile. This is a read-only field that can be left blank.
active?booleanWhether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
advertiserFilter?objectIdentifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
campaignFilter?objectIdentifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
comments?stringComments for this user profile.
email?stringEmail 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?stringID of the user profile. This is a read-only, auto-generated field.
locale?stringLocale 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?stringName 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?objectIdentifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
subaccountId?stringSubaccount ID of the user profile. This is a read-only field that can be left blank.
traffickerType?enumTrafficker type of this user profile. This is a read-only field.
userAccessType?enumUser type of the user profile. This is a read-only field that can be left blank.
userRoleFilter?objectIdentifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
userRoleId?stringUser role ID of the user profile. This is a required field.
profileIdstringUser profile ID associated with this request.
createCreate a accountUserProfiles
getGet a accountUserProfiles
ArgumentTypeDescription
identifierstringThe id of the accountUserProfiles
updateUpdate accountUserProfiles attributes
syncSync accountUserProfiles state from GCP
userprofiles.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a userProfiles
ArgumentTypeDescription
identifierstringThe name of the userProfiles
syncSync userProfiles state from GCP
mobilecarriers.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a mobileCarriers
ArgumentTypeDescription
identifierstringThe id of the mobileCarriers
syncSync mobileCarriers state from GCP
dynamicfeeds.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
dynamicFeed?objectOptional. The name of the content source. It is defaulted to content source file name if not provided.
dynamicProfileId?stringRequired. Dynamic profile ID of the inserted dynamic feed.
contentSource?objectOptional. The name of the content source. It is defaulted to content source file name if not provided.
createInfo?objectTimestamp of the last change in milliseconds since epoch.
dynamicFeedId?stringOutput only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
dynamicFeedName?stringOptional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
element?objectOptional. The field ID to specify the active field in the feed.
feedIngestionStatus?objectOutput only. The ID of the field.
feedSchedule?objectOptional. 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?booleanOutput only. Indicates whether the dynamic feed has a published version. This is a read-only field.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
status?enumOutput 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?stringRequired. Advertiser ID of this dynamic feed. This is a required field.
createCreate a dynamicFeeds
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a dynamicFeeds
ArgumentTypeDescription
identifierstringThe name of the dynamicFeeds
updateUpdate dynamicFeeds attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
syncSync dynamicFeeds state from GCP
retransformretransform
cities.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a cities
ArgumentTypeDescription
identifierstringThe name of the cities
syncSync cities state from GCP
operatingsystemversions.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a operatingSystemVersions
ArgumentTypeDescription
identifierstringThe id of the operatingSystemVersions
syncSync operatingSystemVersions state from GCP
accountactiveadsummaries.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a accountActiveAdSummaries
ArgumentTypeDescription
identifierstringThe name of the accountActiveAdSummaries
syncSync accountActiveAdSummaries state from GCP
ads.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accountId?stringAccount ID of this ad. This is a read-only field that can be left blank.
active?booleanWhether this ad is active. When true, archived must be false.
advertiserId?stringAdvertiser ID of this ad. This is a required field on insertion.
advertiserIdDimensionValue?objectThe name of the dimension.
archived?booleanWhether this ad is archived. When true, active must be false.
audienceSegmentId?stringAudience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
campaignId?stringCampaign ID of this ad. This is a required field on insertion.
campaignIdDimensionValue?objectThe name of the dimension.
clickThroughUrl?objectRead-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?objectClick-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
comments?stringComments for this ad.
compatibility?enumCompatibility 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?objectThe keyword that can be targeted by ads.
createInfo?objectTimestamp of the last change in milliseconds since epoch.
creativeGroupAssignments?arrayID of the creative group to be assigned.
creativeRotation?objectWhether this creative assignment is active. When true, the creative will be included in the ad's rotation.
dayPartTargeting?objectDays of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
defaultClickThroughEventTagProperties?objectID of the click-through event tag to apply to all ads in this entity's scope.
deliverySchedule?objectDuration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
dynamicClickTracker?booleanWhether 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?arrayWhether this override is enabled.
geoTargeting?objectCountry code of the country to which this city belongs.
id?stringID of this ad. This is a read-only, auto-generated field.
idDimensionValue?objectThe name of the dimension.
keyValueTargetingExpression?objectKeyword expression being targeted by the ad.
languageTargeting?objectLanguage ID of this language. This is the ID used for targeting and generating reports.
lastModifiedInfo?objectTimestamp of the last change in milliseconds since epoch.
name?stringName of this ad. This is a required field and must be less than 256 characters long.
placementAssignments?arrayWhether this placement assignment is active. When true, the placement will be included in the ad's rotation.
remarketingListExpression?objectExpression describing which lists are being targeted by the ad.
size?objectHeight of this size. Acceptable values are 0 to 32767, inclusive.
sslCompliant?booleanWhether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
sslRequired?booleanWhether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
startTime?string
subaccountId?stringSubaccount ID of this ad. This is a read-only field that can be left blank.
targetingTemplateId?stringTargeting 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?objectID referring to this grouping of browser and version numbers. This is the ID used for targeting.
type?enumType of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
profileIdstringUser profile ID associated with this request.
createCreate a ads
getGet a ads
ArgumentTypeDescription
identifierstringThe id of the ads
updateUpdate ads attributes
syncSync ads state from GCP