Gcp/displayvideo

@swamp/gcp/displayvideov2026.04.23.1· 8d agoMODELS

01README

Google Cloud displayvideo infrastructure models

02Models39

advertisers_adassets.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
adAsset?	object	no	Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
advertiserId	string	yes	Required. The ID of the advertiser this ad asset belongs to.

fn create()

Create a adAssets

fn get(identifier: string)

Get a adAssets

Argument	Type	Required	Description
identifier	string	yes	The name of the adAssets

fn sync()

Sync adAssets state from GCP

fn bulk_create(adAssets?: any)

bulk create

Argument	Type	Required	Description
adAssets?	any	no

fn upload(adAssetType?: any, filename?: any)

upload

Argument	Type	Required	Description
adAssetType?	any	no
filename?	any	no

partners_channels_sites.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
urlOrAppId?	string	no	Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
partnerId	string	yes	The ID of the partner that owns the parent channel.
channelId	string	yes	Required. The ID of the parent channel in which the site will be created.
advertiserId?	string	no	The ID of the advertiser that owns the parent channel.

fn create()

Create a sites

fn get(identifier: string)

Get a sites

Argument	Type	Required	Description
identifier	string	yes	The name of the sites

fn delete(identifier: string)

Delete the sites

Argument	Type	Required	Description
identifier	string	yes	The name of the sites

fn sync()

Sync sites state from GCP

fn bulk_edit(advertiserId?: any, createdSites?: any, deletedSites?: any, partnerId?: any)

bulk edit

Argument	Type	Required
advertiserId?	any	no
createdSites?	any	no
deletedSites?	any	no
partnerId?	any	no

fn replace(advertiserId?: any, newSites?: any, partnerId?: any)

replace

Argument	Type	Required
advertiserId?	any	no
newSites?	any	no
partnerId?	any	no

advertisers_locationlists.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	Required. Immutable. The unique ID of the advertiser the location list belongs to.
displayName?	string	no	Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
locationType?	enum	no	Required. Immutable. The type of location. All locations in the list will share this type.

fn create()

Create a locationLists

fn get(identifier: string)

Get a locationLists

Argument	Type	Required	Description
identifier	string	yes	The name of the locationLists

fn update()

Update locationLists attributes

fn sync()

Sync locationLists state from GCP

advertisers_negativekeywordlists.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	Output only. The unique ID of the advertiser the negative keyword list belongs to.
displayName?	string	no	Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.

fn create()

Create a negativeKeywordLists

fn get(identifier: string)

Get a negativeKeywordLists

Argument	Type	Required	Description
identifier	string	yes	The name of the negativeKeywordLists

fn update()

Update negativeKeywordLists attributes

fn delete(identifier: string)

Delete the negativeKeywordLists

Argument	Type	Required	Description
identifier	string	yes	The name of the negativeKeywordLists

fn sync()

Sync negativeKeywordLists state from GCP

floodlightgroups.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
activeViewConfig?	object	no	Required. The display name of the custom metric.
customVariables?	record	no	User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`.
displayName?	string	no	Required. The display name of the Floodlight group.
floodlightGroupId?	string	no	Output only. The unique ID of the Floodlight group. Assigned by the system.
lookbackWindow?	object	no	Lookback window, in days, from the last time a given user clicked on one of your ads.
name?	string	no	Output only. The resource name of the Floodlight group.
webTagType?	enum	no	Required. The web tag type enabled for the Floodlight group.

fn get(identifier: string)

Get a floodlightGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the floodlightGroups

fn update()

Update floodlightGroups attributes

fn sync()

Sync floodlightGroups state from GCP

guaranteedorders.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
defaultCampaignId?	string	no	The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
displayName?	string	no	Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
exchange?	enum	no	Required. Immutable. The exchange where the guaranteed order originated.
publisherName?	string	no	Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
readAccessInherited?	boolean	no	Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
readAdvertiserIds?	array	no	The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
readWriteAdvertiserId?	string	no	The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
readWritePartnerId?	string	no	The partner with read/write access to the guaranteed order.
status?	object	no	Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
advertiserId?	string	no	The ID of the advertiser that the request is being made within.
partnerId?	string	no	The ID of the partner that the request is being made within.

fn create()

Create a guaranteedOrders

fn get(identifier: string)

Get a guaranteedOrders

Argument	Type	Required	Description
identifier	string	yes	The name of the guaranteedOrders

fn update()

Update guaranteedOrders attributes

fn sync()

Sync guaranteedOrders state from GCP

fn edit_guaranteed_order_read_accessors(addedAdvertisers?: any, partnerId?: any, readAccessInherited?: any, removedAdvertisers?: any)

edit guaranteed order read accessors

Argument	Type	Required
addedAdvertisers?	any	no
partnerId?	any	no
readAccessInherited?	any	no
removedAdvertisers?	any	no

partners_channels.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	The ID of the advertiser that owns the channel.
displayName?	string	no	Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
partnerId?	string	no	The ID of the partner that owns the channel.

fn create()

Create a channels

fn get(identifier: string)

Get a channels

Argument	Type	Required	Description
identifier	string	yes	The name of the channels

fn update()

Update channels attributes

fn sync()

Sync channels state from GCP

partners.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a partners

Argument	Type	Required	Description
identifier	string	yes	The name of the partners

fn sync()

Sync partners state from GCP

fn edit_assigned_targeting_options(createRequests?: any, deleteRequests?: any)

edit assigned targeting options

Argument	Type	Required	Description
createRequests?	any	no
deleteRequests?	any	no

firstpartyandpartneraudiences.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
appId?	string	no	Optional. The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
audienceType?	enum	no	Immutable. The type of the audience.
contactInfoList?	object	no	Represents consent for ad personalization.
description?	string	no	Optional. The user-provided description of the audience. Only applicable to first party audiences.
displayName?	string	no	Optional. The display name of the first party and partner audience.
firstPartyAndPartnerAudienceId?	string	no	Identifier. The unique ID of the first party and partner audience. Assigned by the system.
membershipDurationDays?	string	no	Optional. The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
mobileDeviceIdList?	object	no	Represents consent for ad personalization.
advertiserId?	string	no	Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.

fn create()

Create a firstPartyAndPartnerAudiences

fn get(identifier: string)

Get a firstPartyAndPartnerAudiences

Argument	Type	Required	Description
identifier	string	yes	The name of the firstPartyAndPartnerAudiences

fn update()

Update firstPartyAndPartnerAudiences attributes

fn sync()

Sync firstPartyAndPartnerAudiences state from GCP

fn edit_customer_match_members(addedContactInfoList?: any, addedMobileDeviceIdList?: any, advertiserId?: any, removedContactInfoList?: any, removedMobileDeviceIdList?: any)

edit customer match members

Argument	Type	Required
addedContactInfoList?	any	no
addedMobileDeviceIdList?	any	no
advertiserId?	any	no
removedContactInfoList?	any	no
removedMobileDeviceIdList?	any	no

combinedaudiences.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a combinedAudiences

Argument	Type	Required	Description
identifier	string	yes	The name of the combinedAudiences

fn sync()

Sync combinedAudiences state from GCP

advertisers_targetingtypes_assignedtargetingoptions.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ageRangeDetails?	object	no	Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
appCategoryDetails?	object	no	Output only. The display name of the app category.
appDetails?	object	no	Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
audienceGroupDetails?	object	no	Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
audioContentTypeDetails?	object	no	Required. The audio content type.
authorizedSellerStatusDetails?	object	no	Output only. The authorized seller status to target.
browserDetails?	object	no	Output only. The display name of the browser.
businessChainDetails?	object	no	Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
carrierAndIspDetails?	object	no	Output only. The display name of the carrier or ISP.
categoryDetails?	object	no	Output only. The display name of the category.
channelDetails?	object	no	Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
contentDurationDetails?	object	no	Output only. The content duration.
contentGenreDetails?	object	no	Output only. The display name of the content genre.
contentInstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
contentOutstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
contentStreamTypeDetails?	object	no	Output only. The content stream type.
contentThemeExclusionDetails?	object	no	Output only. An enum for the DV360 content theme classifier.
dayAndTimeDetails?	object	no	Required. The day of the week for this day and time targeting setting.
deviceMakeModelDetails?	object	no	Output only. The display name of the device make and model.
deviceTypeDetails?	object	no	Required. The display name of the device type.
digitalContentLabelExclusionDetails?	object	no	Required. The display name of the digital content label rating tier to be EXCLUDED.
environmentDetails?	object	no	Required. The serving environment.
exchangeDetails?	object	no	Required. The enum value for the exchange.
genderDetails?	object	no	Required. The gender of the audience.
geoRegionDetails?	object	no	Output only. The display name of the geographic region (e.g., "Ontario, Canada").
householdIncomeDetails?	object	no	Required. The household income of the audience.
inventorySourceDetails?	object	no	Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
inventorySourceGroupDetails?	object	no	Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
keywordDetails?	object	no	Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
languageDetails?	object	no	Output only. The display name of the language (e.g., "French").
nativeContentPositionDetails?	object	no	Required. The content position.
negativeKeywordListDetails?	object	no	Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
omidDetails?	object	no	Required. The type of Open Measurement enabled inventory.
onScreenPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
operatingSystemDetails?	object	no	Output only. The display name of the operating system.
parentalStatusDetails?	object	no	Required. The parental status of the audience.
poiDetails?	object	no	Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
proximityLocationListDetails?	object	no	Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
regionalLocationListDetails?	object	no	Indicates if this option is being negatively targeted.
sensitiveCategoryExclusionDetails?	object	no	Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
sessionPositionDetails?	object	no	The position where the ad will show in a session.
subExchangeDetails?	object	no	Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
targetingType?	enum	no	Output only. Identifies the type of this assigned targeting option.
thirdPartyVerifierDetails?	object	no	Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
urlDetails?	object	no	Indicates if this option is being negatively targeted.
userRewardedContentDetails?	object	no	Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
videoPlayerSizeDetails?	object	no	Required. The video player size.
viewabilityDetails?	object	no	Required. The predicted viewability percentage.
youtubeChannelDetails?	object	no	The YouTube uploader channel id or the channel code of a YouTube channel.
youtubeVideoDetails?	object	no	Indicates if this option is being negatively targeted.
advertiserId	string	yes	Required. The ID of the advertiser.

fn create()

Create a assignedTargetingOptions

fn get(identifier: string)

Get a assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn delete(identifier: string)

Delete the assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn sync()

Sync assignedTargetingOptions state from GCP

advertisers_channels_sites.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
urlOrAppId?	string	no	Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.
advertiserId	string	yes	The ID of the advertiser that owns the parent channel.
channelId	string	yes	Required. The ID of the parent channel in which the site will be created.
partnerId?	string	no	The ID of the partner that owns the parent channel.

fn create()

Create a sites

fn get(identifier: string)

Get a sites

Argument	Type	Required	Description
identifier	string	yes	The name of the sites

fn delete(identifier: string)

Delete the sites

Argument	Type	Required	Description
identifier	string	yes	The name of the sites

fn sync()

Sync sites state from GCP

fn bulk_edit(advertiserId?: any, createdSites?: any, deletedSites?: any, partnerId?: any)

bulk edit

Argument	Type	Required
advertiserId?	any	no
createdSites?	any	no
deletedSites?	any	no
partnerId?	any	no

fn replace(advertiserId?: any, newSites?: any, partnerId?: any)

replace

Argument	Type	Required
advertiserId?	any	no
newSites?	any	no
partnerId?	any	no

custombiddingalgorithms_scripts.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
customBiddingAlgorithmId?	string	no	Output only. The unique ID of the custom bidding algorithm the script belongs to.
script?	object	no	A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.
advertiserId?	string	no	The ID of the advertiser that owns the parent custom bidding algorithm.
partnerId?	string	no	The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

fn create()

Create a scripts

fn get(identifier: string)

Get a scripts

Argument	Type	Required	Description
identifier	string	yes	The name of the scripts

fn sync()

Sync scripts state from GCP

advertisers_adgroups_youtubeassettypes_youtubeassetassociations.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
linkedYoutubeAsset?	object	no	Required. ID of the affiliate location chain.
name?	string	no	Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
youtubeAssetType?	enum	no	Required. The type of YouTube asset associated with the resource.
advertiserId	string	yes	Required. The ID of the advertiser that the linked entity belongs to.
adGroupId	string	yes	The ID of an ad group.
linkedEntity_lineItemId?	string	no	The ID of a line item.

fn create()

Create a youtubeAssetAssociations

fn get(identifier: string)

Get a youtubeAssetAssociations

Argument	Type	Required	Description
identifier	string	yes	The name of the youtubeAssetAssociations

fn delete(identifier: string)

Delete the youtubeAssetAssociations

Argument	Type	Required	Description
identifier	string	yes	The name of the youtubeAssetAssociations

fn sync()

Sync youtubeAssetAssociations state from GCP

users.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
email?	string	no	Required. Immutable. The email address used to identify the user.

fn create()

Create a users

fn get(identifier: string)

Get a users

Argument	Type	Required	Description
identifier	string	yes	The name of the users

fn update()

Update users attributes

fn delete(identifier: string)

Delete the users

Argument	Type	Required	Description
identifier	string	yes	The name of the users

fn sync()

Sync users state from GCP

fn bulk_edit_assigned_user_roles(createdAssignedUserRoles?: any, deletedAssignedUserRoles?: any)

bulk edit assigned user roles

Argument	Type	Required	Description
createdAssignedUserRoles?	any	no
deletedAssignedUserRoles?	any	no

inventorysourcegroups.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.
advertiserId?	string	no	The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
partnerId?	string	no	The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.

fn create()

Create a inventorySourceGroups

fn get(identifier: string)

Get a inventorySourceGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the inventorySourceGroups

fn update()

Update inventorySourceGroups attributes

fn delete(identifier: string)

Delete the inventorySourceGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the inventorySourceGroups

fn sync()

Sync inventorySourceGroups state from GCP

custombiddingalgorithms.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
customBiddingAlgorithmType?	enum	no	Required. Immutable. The type of custom bidding algorithm.
displayName?	string	no	Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus?	enum	no	Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
partnerId?	string	no	Immutable. The unique ID of the partner that owns the custom bidding algorithm.
sharedAdvertiserIds?	array	no	The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).
thirdPartyOptimizationPartner?	enum	no	Optional. Immutable. Designates the third party optimization partner that manages this algorithm.

fn create()

Create a customBiddingAlgorithms

fn get(identifier: string)

Get a customBiddingAlgorithms

Argument	Type	Required	Description
identifier	string	yes	The name of the customBiddingAlgorithms

fn update()

Update customBiddingAlgorithms attributes

fn sync()

Sync customBiddingAlgorithms state from GCP

fn upload_rules()

upload rules

fn upload_script()

upload script

advertisers_adgroups_targetingtypes_assignedtargetingoptions.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ageRangeDetails?	object	no	Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
appCategoryDetails?	object	no	Output only. The display name of the app category.
appDetails?	object	no	Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
audienceGroupDetails?	object	no	Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
audioContentTypeDetails?	object	no	Required. The audio content type.
authorizedSellerStatusDetails?	object	no	Output only. The authorized seller status to target.
browserDetails?	object	no	Output only. The display name of the browser.
businessChainDetails?	object	no	Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
carrierAndIspDetails?	object	no	Output only. The display name of the carrier or ISP.
categoryDetails?	object	no	Output only. The display name of the category.
channelDetails?	object	no	Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
contentDurationDetails?	object	no	Output only. The content duration.
contentGenreDetails?	object	no	Output only. The display name of the content genre.
contentInstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
contentOutstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
contentStreamTypeDetails?	object	no	Output only. The content stream type.
contentThemeExclusionDetails?	object	no	Output only. An enum for the DV360 content theme classifier.
dayAndTimeDetails?	object	no	Required. The day of the week for this day and time targeting setting.
deviceMakeModelDetails?	object	no	Output only. The display name of the device make and model.
deviceTypeDetails?	object	no	Required. The display name of the device type.
digitalContentLabelExclusionDetails?	object	no	Required. The display name of the digital content label rating tier to be EXCLUDED.
environmentDetails?	object	no	Required. The serving environment.
exchangeDetails?	object	no	Required. The enum value for the exchange.
genderDetails?	object	no	Required. The gender of the audience.
geoRegionDetails?	object	no	Output only. The display name of the geographic region (e.g., "Ontario, Canada").
householdIncomeDetails?	object	no	Required. The household income of the audience.
inventorySourceDetails?	object	no	Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
inventorySourceGroupDetails?	object	no	Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
keywordDetails?	object	no	Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
languageDetails?	object	no	Output only. The display name of the language (e.g., "French").
nativeContentPositionDetails?	object	no	Required. The content position.
negativeKeywordListDetails?	object	no	Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
omidDetails?	object	no	Required. The type of Open Measurement enabled inventory.
onScreenPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
operatingSystemDetails?	object	no	Output only. The display name of the operating system.
parentalStatusDetails?	object	no	Required. The parental status of the audience.
poiDetails?	object	no	Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
proximityLocationListDetails?	object	no	Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
regionalLocationListDetails?	object	no	Indicates if this option is being negatively targeted.
sensitiveCategoryExclusionDetails?	object	no	Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
sessionPositionDetails?	object	no	The position where the ad will show in a session.
subExchangeDetails?	object	no	Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
targetingType?	enum	no	Output only. Identifies the type of this assigned targeting option.
thirdPartyVerifierDetails?	object	no	Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
urlDetails?	object	no	Indicates if this option is being negatively targeted.
userRewardedContentDetails?	object	no	Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
videoPlayerSizeDetails?	object	no	Required. The video player size.
viewabilityDetails?	object	no	Required. The predicted viewability percentage.
youtubeChannelDetails?	object	no	The YouTube uploader channel id or the channel code of a YouTube channel.
youtubeVideoDetails?	object	no	Indicates if this option is being negatively targeted.
advertiserId	string	yes	Required. The ID of the advertiser the ad group belongs to.
adGroupId	string	yes	Required. The ID of the ad group the assigned targeting option will belong to.

fn create()

Create a assignedTargetingOptions

fn get(identifier: string)

Get a assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn delete(identifier: string)

Delete the assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn sync()

Sync assignedTargetingOptions state from GCP

advertisers_insertionorders.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	Output only. The unique ID of the advertiser the insertion order belongs to.
bidStrategy?	object	no	Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.
budget?	object	no	Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
campaignId?	string	no	Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
displayName?	string	no	Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus?	enum	no	Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
frequencyCap?	object	no	The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
insertionOrderType?	enum	no	Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
integrationDetails?	object	no	Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
kpi?	object	no	Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.
optimizationObjective?	enum	no	Optional. Required. The optimization objective of the insertion order.
pacing?	object	no	Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
partnerCosts?	array	no	Required. The type of the partner cost.

fn create()

Create a insertionOrders

fn get(identifier: string)

Get a insertionOrders

Argument	Type	Required	Description
identifier	string	yes	The name of the insertionOrders

fn update()

Update insertionOrders attributes

fn delete(identifier: string)

Delete the insertionOrders

Argument	Type	Required	Description
identifier	string	yes	The name of the insertionOrders

fn sync()

Sync insertionOrders state from GCP

advertisers_campaigns.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	Output only. The unique ID of the advertiser the campaign belongs to.
campaignBudgets?	array	no	Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.
campaignFlight?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
campaignGoal?	object	no	Required. The type of the campaign goal.
displayName?	string	no	Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus?	enum	no	Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed.
frequencyCap?	object	no	The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.

fn create()

Create a campaigns

fn get(identifier: string)

Get a campaigns

Argument	Type	Required	Description
identifier	string	yes	The name of the campaigns

fn update()

Update campaigns attributes

fn delete(identifier: string)

Delete the campaigns

Argument	Type	Required	Description
identifier	string	yes	The name of the campaigns

fn sync()

Sync campaigns state from GCP

custombiddingalgorithms_rules.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
customBiddingAlgorithmId?	string	no	Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
error?	object	no	The type of error.
rules?	object	no	A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.
advertiserId?	string	no	The ID of the advertiser that owns the parent custom bidding algorithm.
partnerId?	string	no	The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.

fn create()

Create a rules

fn get(identifier: string)

Get a rules

Argument	Type	Required	Description
identifier	string	yes	The name of the rules

fn sync()

Sync rules state from GCP

advertisers_invoices.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a invoices

Argument	Type	Required	Description
identifier	string	yes	The name of the invoices

fn sync()

Sync invoices state from GCP

fn lookup_invoice_currency()

lookup invoice currency

inventorysources.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
commitment?	enum	no	Whether the inventory source has a guaranteed or non-guaranteed delivery.
creativeConfigs?	array	no	The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
dealId?	string	no	The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
deliveryMethod?	enum	no	The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
displayName?	string	no	The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
exchange?	enum	no	The exchange to which the inventory source belongs.
guaranteedOrderId?	string	no	Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
inventorySourceType?	enum	no	Denotes the type of the inventory source.
publisherName?	string	no	The publisher/seller name of the inventory source.
rateDetails?	object	no	The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
readWriteAccessors?	object	no	The IDs of the advertisers.
status?	object	no	Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
timeRange?	object	no	Required. The upper bound of a time range, inclusive.
advertiserId?	string	no	The ID of the advertiser that the request is being made within.
partnerId?	string	no	The ID of the partner that the request is being made within.

fn create()

Create a inventorySources

fn get(identifier: string)

Get a inventorySources

Argument	Type	Required	Description
identifier	string	yes	The name of the inventorySources

fn update()

Update inventorySources attributes

fn sync()

Sync inventorySources state from GCP

fn edit_inventory_source_read_write_accessors(advertisersUpdate?: any, assignPartner?: any, partnerId?: any)

edit inventory source read write accessors

Argument	Type	Required
advertisersUpdate?	any	no
assignPartner?	any	no
partnerId?	any	no

advertisers_lineitems_youtubeassettypes_youtubeassetassociations.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
linkedYoutubeAsset?	object	no	Required. ID of the affiliate location chain.
name?	string	no	Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
youtubeAssetType?	enum	no	Required. The type of YouTube asset associated with the resource.
advertiserId	string	yes	Required. The ID of the advertiser that the linked entity belongs to.
lineItemId	string	yes	The ID of a line item.
linkedEntity_adGroupId?	string	no	The ID of an ad group.

fn create()

Create a youtubeAssetAssociations

fn get(identifier: string)

Get a youtubeAssetAssociations

Argument	Type	Required	Description
identifier	string	yes	The name of the youtubeAssetAssociations

fn delete(identifier: string)

Delete the youtubeAssetAssociations

Argument	Type	Required	Description
identifier	string	yes	The name of the youtubeAssetAssociations

fn sync()

Sync youtubeAssetAssociations state from GCP

partners_targetingtypes_assignedtargetingoptions.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ageRangeDetails?	object	no	Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
appCategoryDetails?	object	no	Output only. The display name of the app category.
appDetails?	object	no	Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
audienceGroupDetails?	object	no	Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
audioContentTypeDetails?	object	no	Required. The audio content type.
authorizedSellerStatusDetails?	object	no	Output only. The authorized seller status to target.
browserDetails?	object	no	Output only. The display name of the browser.
businessChainDetails?	object	no	Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
carrierAndIspDetails?	object	no	Output only. The display name of the carrier or ISP.
categoryDetails?	object	no	Output only. The display name of the category.
channelDetails?	object	no	Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
contentDurationDetails?	object	no	Output only. The content duration.
contentGenreDetails?	object	no	Output only. The display name of the content genre.
contentInstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
contentOutstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
contentStreamTypeDetails?	object	no	Output only. The content stream type.
contentThemeExclusionDetails?	object	no	Output only. An enum for the DV360 content theme classifier.
dayAndTimeDetails?	object	no	Required. The day of the week for this day and time targeting setting.
deviceMakeModelDetails?	object	no	Output only. The display name of the device make and model.
deviceTypeDetails?	object	no	Required. The display name of the device type.
digitalContentLabelExclusionDetails?	object	no	Required. The display name of the digital content label rating tier to be EXCLUDED.
environmentDetails?	object	no	Required. The serving environment.
exchangeDetails?	object	no	Required. The enum value for the exchange.
genderDetails?	object	no	Required. The gender of the audience.
geoRegionDetails?	object	no	Output only. The display name of the geographic region (e.g., "Ontario, Canada").
householdIncomeDetails?	object	no	Required. The household income of the audience.
inventorySourceDetails?	object	no	Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
inventorySourceGroupDetails?	object	no	Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
keywordDetails?	object	no	Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
languageDetails?	object	no	Output only. The display name of the language (e.g., "French").
nativeContentPositionDetails?	object	no	Required. The content position.
negativeKeywordListDetails?	object	no	Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
omidDetails?	object	no	Required. The type of Open Measurement enabled inventory.
onScreenPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
operatingSystemDetails?	object	no	Output only. The display name of the operating system.
parentalStatusDetails?	object	no	Required. The parental status of the audience.
poiDetails?	object	no	Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
proximityLocationListDetails?	object	no	Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
regionalLocationListDetails?	object	no	Indicates if this option is being negatively targeted.
sensitiveCategoryExclusionDetails?	object	no	Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
sessionPositionDetails?	object	no	The position where the ad will show in a session.
subExchangeDetails?	object	no	Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
targetingType?	enum	no	Output only. Identifies the type of this assigned targeting option.
thirdPartyVerifierDetails?	object	no	Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
urlDetails?	object	no	Indicates if this option is being negatively targeted.
userRewardedContentDetails?	object	no	Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
videoPlayerSizeDetails?	object	no	Required. The video player size.
viewabilityDetails?	object	no	Required. The predicted viewability percentage.
youtubeChannelDetails?	object	no	The YouTube uploader channel id or the channel code of a YouTube channel.
youtubeVideoDetails?	object	no	Indicates if this option is being negatively targeted.
partnerId	string	yes	Required. The ID of the partner.

fn create()

Create a assignedTargetingOptions

fn get(identifier: string)

Get a assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn delete(identifier: string)

Delete the assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn sync()

Sync assignedTargetingOptions state from GCP

advertisers_negativekeywordlists_negativekeywords.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
keywordValue?	string	no	Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.
advertiserId	string	yes	Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
negativeKeywordListId	string	yes	Required. The ID of the parent negative keyword list in which the negative keyword will be created.

fn create()

Create a negativeKeywords

fn get(identifier: string)

Get a negativeKeywords

Argument	Type	Required	Description
identifier	string	yes	The name of the negativeKeywords

fn delete(identifier: string)

Delete the negativeKeywords

Argument	Type	Required	Description
identifier	string	yes	The name of the negativeKeywords

fn sync()

Sync negativeKeywords state from GCP

fn bulk_edit(createdNegativeKeywords?: any, deletedNegativeKeywords?: any)

bulk edit

Argument	Type	Required	Description
createdNegativeKeywords?	any	no
deletedNegativeKeywords?	any	no

fn replace(newNegativeKeywords?: any)

replace

Argument	Type	Required	Description
newNegativeKeywords?	any	no

advertisers_creatives.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
additionalDimensions?	array	no	The height in pixels.
advertiserId?	string	no	Output only. The unique ID of the advertiser the creative belongs to.
appendedTag?	string	no	Optional. Third-party HTML tracking tag to be appended to the creative tag.
assets?	array	no	The asset content. For uploaded assets, the content is the serving path.
cmTrackingAd?	object	no	Optional. The ad ID of the campaign manager 360 tracking Ad.
companionCreativeIds?	array	no	Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
counterEvents?	array	no	Required. The name of the counter event.
creativeType?	enum	no	Required. Immutable. The type of the creative.
dimensions?	object	no	The height in pixels.
displayName?	string	no	Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus?	enum	no	Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
exitEvents?	array	no	Optional. The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only.
expandOnHover?	boolean	no	Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
expandingDirection?	enum	no	Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
hostingSource?	enum	no	Required. Indicates where the creative is hosted.
iasCampaignMonitoring?	boolean	no	Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
integrationCode?	string	no	Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
jsTrackerUrl?	string	no	Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
notes?	string	no	Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
obaIcon?	object	no	Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * `https://info.evidon.com` * `https://l.betrad.com`
progressOffset?	object	no	Optional. The offset in percentage of the audio or video duration.
requireHtml5?	boolean	no	Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
requireMraid?	boolean	no	Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
requirePingForAttribution?	boolean	no	Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
reviewStatus?	object	no	Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
skipOffset?	object	no	Optional. The offset in percentage of the audio or video duration.
skippable?	boolean	no	Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
thirdPartyTag?	string	no	Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
thirdPartyUrls?	array	no	Optional. The type of interaction needs to be tracked by the tracking URL
timerEvents?	array	no	Required. The name of the timer event.
trackerUrls?	array	no	Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
universalAdId?	object	no	Optional. The unique creative identifier.
vastTagUrl?	string	no	Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`

fn create()

Create a creatives

fn get(identifier: string)

Get a creatives

Argument	Type	Required	Description
identifier	string	yes	The name of the creatives

fn update()

Update creatives attributes

fn delete(identifier: string)

Delete the creatives

Argument	Type	Required	Description
identifier	string	yes	The name of the creatives

fn sync()

Sync creatives state from GCP

advertisers_adgroupads.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
adGroupId?	string	no	Required. Immutable. The unique ID of the ad group that the ad belongs to.
adPolicy?	object	no	The policy approval status of an ad, indicating the approval decision.
advertiserId?	string	no	Output only. The unique ID of the advertiser the ad belongs to.
audioAd?	object	no	The webpage address that appears with the ad.
bumperAd?	object	no	The text on the call-to-action button.
dcmTrackingInfo?	object	no	Required. The DCM creative id.
demandGenCarouselAd?	object	no	Required. The business name shown on the ad.
demandGenImageAd?	object	no	Required. The business name shown on the ad.
demandGenProductAd?	object	no	Required. The business name shown on the ad.
demandGenVideoAd?	object	no	Required. The business name shown on the ad.
displayName?	string	no	Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
displayVideoSourceAd?	object	no	The ID of the source creative.
entityStatus?	enum	no	Required. The entity status of the ad.
inStreamAd?	object	no	The text on the call-to-action button.
mastheadAd?	object	no	The duration of time the video will autoplay.
nonSkippableAd?	object	no	The text on the call-to-action button.
videoDiscoverAd?	object	no	First text line for the ad.
videoPerformanceAd?	object	no	The list of text assets shown on the call-to-action button.

fn create()

Create a adGroupAds

fn get(identifier: string)

Get a adGroupAds

Argument	Type	Required	Description
identifier	string	yes	The name of the adGroupAds

fn update()

Update adGroupAds attributes

fn delete(identifier: string)

Delete the adGroupAds

Argument	Type	Required	Description
identifier	string	yes	The name of the adGroupAds

fn sync()

Sync adGroupAds state from GCP

advertisers.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
adServerConfig?	object	no	Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
billingConfig?	object	no	Required. The ID of a billing profile assigned to the advertiser.
containsEuPoliticalAds?	enum	no	Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day.
creativeConfig?	object	no	Whether or not the advertiser is enabled for dynamic creatives.
dataAccessConfig?	object	no	Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig.
displayName?	string	no	Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus?	enum	no	Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
generalConfig?	object	no	Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code: Currency Name * `ARS`: Argentine Peso * `AUD`: Australian Dollar * `BRL`: Brazilian Real * `CAD`: Canadian Dollar * `CHF`: Swiss Franc * `CLP`: Chilean Peso * `CNY`: Chinese Yuan * `COP`: Colombian Peso * `CZK`: Czech Koruna * `DKK`: Danish Krone * `EGP`: Egyption Pound * `EUR`: Euro * `GBP`: British Pound * `HKD`: Hong Kong Dollar * `HUF`: Hungarian Forint * `IDR`: Indonesian Rupiah * `ILS`: Israeli Shekel * `INR`: Indian Rupee * `JPY`: Japanese Yen * `KRW`: South Korean Won * `MXN`: Mexican Pesos * `MYR`: Malaysian Ringgit * `NGN`: Nigerian Naira * `NOK`: Norwegian Krone * `NZD`: New Zealand Dollar * `PEN`: Peruvian Nuevo Sol * `PLN`: Polish Zloty * `RON`: New Romanian Leu * `RUB`: Russian Ruble * `SEK`: Swedish Krona * `TRY`: Turkish Lira * `TWD`: New Taiwan Dollar * `USD`: US Dollar * `ZAR`: South African Rand
integrationDetails?	object	no	Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
partnerId?	string	no	Required. Immutable. The unique ID of the partner that the advertiser belongs to.
prismaEnabled?	boolean	no	Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
servingConfig?	object	no	Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.

fn create()

Create a advertisers

fn get(identifier: string)

Get a advertisers

Argument	Type	Required	Description
identifier	string	yes	The name of the advertisers

fn update()

Update advertisers attributes

fn delete(identifier: string)

Delete the advertisers

Argument	Type	Required	Description
identifier	string	yes	The name of the advertisers

fn sync()

Sync advertisers state from GCP

fn audit()

audit

fn edit_assigned_targeting_options(createRequests?: any, deleteRequests?: any)

edit assigned targeting options

Argument	Type	Required	Description
createRequests?	any	no
deleteRequests?	any	no

fn list_assigned_targeting_options()

list assigned targeting options

advertisers_channels.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	The ID of the advertiser that owns the channel.
displayName?	string	no	Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes.
partnerId?	string	no	The ID of the partner that owns the channel.

fn create()

Create a channels

fn get(identifier: string)

Get a channels

Argument	Type	Required	Description
identifier	string	yes	The name of the channels

fn update()

Update channels attributes

fn sync()

Sync channels state from GCP

advertisers_lineitems_targetingtypes_assignedtargetingoptions.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ageRangeDetails?	object	no	Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
appCategoryDetails?	object	no	Output only. The display name of the app category.
appDetails?	object	no	Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
audienceGroupDetails?	object	no	Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
audioContentTypeDetails?	object	no	Required. The audio content type.
authorizedSellerStatusDetails?	object	no	Output only. The authorized seller status to target.
browserDetails?	object	no	Output only. The display name of the browser.
businessChainDetails?	object	no	Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
carrierAndIspDetails?	object	no	Output only. The display name of the carrier or ISP.
categoryDetails?	object	no	Output only. The display name of the category.
channelDetails?	object	no	Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
contentDurationDetails?	object	no	Output only. The content duration.
contentGenreDetails?	object	no	Output only. The display name of the content genre.
contentInstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
contentOutstreamPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
contentStreamTypeDetails?	object	no	Output only. The content stream type.
contentThemeExclusionDetails?	object	no	Output only. An enum for the DV360 content theme classifier.
dayAndTimeDetails?	object	no	Required. The day of the week for this day and time targeting setting.
deviceMakeModelDetails?	object	no	Output only. The display name of the device make and model.
deviceTypeDetails?	object	no	Required. The display name of the device type.
digitalContentLabelExclusionDetails?	object	no	Required. The display name of the digital content label rating tier to be EXCLUDED.
environmentDetails?	object	no	Required. The serving environment.
exchangeDetails?	object	no	Required. The enum value for the exchange.
genderDetails?	object	no	Required. The gender of the audience.
geoRegionDetails?	object	no	Output only. The display name of the geographic region (e.g., "Ontario, Canada").
householdIncomeDetails?	object	no	Required. The household income of the audience.
inventorySourceDetails?	object	no	Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
inventorySourceGroupDetails?	object	no	Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
keywordDetails?	object	no	Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
languageDetails?	object	no	Output only. The display name of the language (e.g., "French").
nativeContentPositionDetails?	object	no	Required. The content position.
negativeKeywordListDetails?	object	no	Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
omidDetails?	object	no	Required. The type of Open Measurement enabled inventory.
onScreenPositionDetails?	object	no	Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
operatingSystemDetails?	object	no	Output only. The display name of the operating system.
parentalStatusDetails?	object	no	Required. The parental status of the audience.
poiDetails?	object	no	Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
proximityLocationListDetails?	object	no	Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
regionalLocationListDetails?	object	no	Indicates if this option is being negatively targeted.
sensitiveCategoryExclusionDetails?	object	no	Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
sessionPositionDetails?	object	no	The position where the ad will show in a session.
subExchangeDetails?	object	no	Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
targetingType?	enum	no	Output only. Identifies the type of this assigned targeting option.
thirdPartyVerifierDetails?	object	no	Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
urlDetails?	object	no	Indicates if this option is being negatively targeted.
userRewardedContentDetails?	object	no	Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
videoPlayerSizeDetails?	object	no	Required. The video player size.
viewabilityDetails?	object	no	Required. The predicted viewability percentage.
youtubeChannelDetails?	object	no	The YouTube uploader channel id or the channel code of a YouTube channel.
youtubeVideoDetails?	object	no	Indicates if this option is being negatively targeted.
advertiserId	string	yes	Required. The ID of the advertiser the line item belongs to.
lineItemId	string	yes	Required. The ID of the line item the assigned targeting option will belong to.

fn create()

Create a assignedTargetingOptions

fn get(identifier: string)

Get a assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn delete(identifier: string)

Delete the assignedTargetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedTargetingOptions

fn sync()

Sync assignedTargetingOptions state from GCP

floodlightgroups_floodlightactivities.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a floodlightActivities

Argument	Type	Required	Description
identifier	string	yes	The name of the floodlightActivities

fn sync()

Sync floodlightActivities state from GCP

targetingtypes_targetingoptions.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a targetingOptions

Argument	Type	Required	Description
identifier	string	yes	The name of the targetingOptions

fn sync()

Sync targetingOptions state from GCP

fn search(advertiserId?: any, businessChainSearchTerms?: any, geoRegionSearchTerms?: any, pageSize?: any, pageToken?: any, poiSearchTerms?: any)

Argument	Type	Required
advertiserId?	any	no
businessChainSearchTerms?	any	no
geoRegionSearchTerms?	any	no
pageSize?	any	no
pageToken?	any	no
poiSearchTerms?	any	no

advertisers_lineitems.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
advertiserId?	string	no	Output only. The unique ID of the advertiser the line item belongs to.
bidStrategy?	object	no	Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.
budget?	object	no	Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items.
containsEuPoliticalAds?	enum	no	Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, the `advertisers.lineItems.create` request will fail.
conversionCounting?	object	no	Required. The ID of the Floodlight activity.
creativeIds?	array	no	The IDs of the creatives associated with the line item.
demandGenSettings?	object	no	Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups.
displayName?	string	no	Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus?	enum	no	Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
excludeNewExchanges?	boolean	no	Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
flight?	object	no	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
frequencyCap?	object	no	The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
insertionOrderId?	string	no	Required. Immutable. The unique ID of the insertion order that the line item belongs to.
integrationDetails?	object	no	Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
lineItemType?	enum	no	Required. Immutable. The type of the line item.
mobileApp?	object	no	Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
optimizeFixedBidding?	boolean	no	Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`.
pacing?	object	no	Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
partnerCosts?	array	no	Required. The type of the partner cost.
partnerRevenueModel?	object	no	Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
targetingExpansion?	object	no	Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
youtubeAndPartnersSettings?	object	no	Output only. The kind of content on which the YouTube and Partners ads will be shown. Warning: This field will be removed in the near future. Use effective_content_category instead.

fn create()

Create a lineItems

fn get(identifier: string)

Get a lineItems

Argument	Type	Required	Description
identifier	string	yes	The name of the lineItems

fn update()

Update lineItems attributes

fn delete(identifier: string)

Delete the lineItems

Argument	Type	Required	Description
identifier	string	yes	The name of the lineItems

fn sync()

Sync lineItems state from GCP

fn bulk_edit_assigned_targeting_options(createRequests?: any, deleteRequests?: any, lineItemIds?: any)

bulk edit assigned targeting options

Argument	Type	Required
createRequests?	any	no
deleteRequests?	any	no
lineItemIds?	any	no

fn bulk_list_assigned_targeting_options()

bulk list assigned targeting options

fn bulk_update(lineItemIds?: any, targetLineItem?: any, updateMask?: any)

bulk update

Argument	Type	Required
lineItemIds?	any	no
targetLineItem?	any	no
updateMask?	any	no

fn duplicate(containsEuPoliticalAds?: any, targetDisplayName?: any)

duplicate

Argument	Type	Required	Description
containsEuPoliticalAds?	any	no
targetDisplayName?	any	no

advertisers_adgroups.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
adGroupFormat?	enum	no	Required. Immutable. The format of the ads in the ad group.
adGroupInventoryControl?	object	no	The inventory strategy.
advertiserId?	string	no	Output only. The unique ID of the advertiser the ad group belongs to.
bidStrategy?	object	no	Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.
displayName?	string	no	Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
entityStatus?	enum	no	Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
lineItemId?	string	no	Required. Immutable. The unique ID of the line item that the ad group belongs to.
productFeedData?	object	no	Whether the product feed has opted-out of showing products.
targetingExpansion?	object	no	Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.

fn create()

Create a adGroups

fn get(identifier: string)

Get a adGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the adGroups

fn update()

Update adGroups attributes

fn delete(identifier: string)

Delete the adGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the adGroups

fn sync()

Sync adGroups state from GCP

fn bulk_edit_assigned_targeting_options(adGroupIds?: any, createRequests?: any, deleteRequests?: any)

bulk edit assigned targeting options

Argument	Type	Required
adGroupIds?	any	no
createRequests?	any	no
deleteRequests?	any	no

fn bulk_list_assigned_targeting_options()

bulk list assigned targeting options

inventorysourcegroups_assignedinventorysources.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
inventorySourceId?	string	no	Required. The ID of the inventory source entity being targeted.
inventorySourceGroupId	string	yes	Required. The ID of the inventory source group to which the assignment will be assigned.
advertiserId?	string	no	The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
partnerId?	string	no	The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.

fn create()

Create a assignedInventorySources

fn get(identifier: string)

Get a assignedInventorySources

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedInventorySources

fn delete(identifier: string)

Delete the assignedInventorySources

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedInventorySources

fn sync()

Sync assignedInventorySources state from GCP

fn bulk_edit(advertiserId?: any, createdAssignedInventorySources?: any, deletedAssignedInventorySources?: any, partnerId?: any)

bulk edit

Argument	Type	Required
advertiserId?	any	no
createdAssignedInventorySources?	any	no
deletedAssignedInventorySources?	any	no
partnerId?	any	no

googleaudiences.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a googleAudiences

Argument	Type	Required	Description
identifier	string	yes	The name of the googleAudiences

fn sync()

Sync googleAudiences state from GCP

advertisers_locationlists_assignedlocations.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
targetingOptionId?	string	no	Required. The ID of the targeting option assigned to the location list.
advertiserId	string	yes	Required. The ID of the DV360 advertiser to which the location list belongs.
locationListId	string	yes	Required. The ID of the location list for which the assignment will be created.

fn create()

Create a assignedLocations

fn get(identifier: string)

Get a assignedLocations

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedLocations

fn delete(identifier: string)

Delete the assignedLocations

Argument	Type	Required	Description
identifier	string	yes	The name of the assignedLocations

fn sync()

Sync assignedLocations state from GCP

fn bulk_edit(createdAssignedLocations?: any, deletedAssignedLocations?: any)

bulk edit

Argument	Type	Required	Description
createdAssignedLocations?	any	no
deletedAssignedLocations?	any	no

customlists.tsv2026.04.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a customLists

Argument	Type	Required	Description
identifier	string	yes	The name of the customLists

fn sync()

Sync customLists state from GCP

03Previous Versions8

2026.04.22.1Apr 22, 2026

Updated: advertisers_adgroups, advertisers_insertionorders, advertisers_lineitems

2026.04.14.1Apr 14, 2026

Updated: advertisers_adgroups, advertisers_insertionorders, advertisers_lineitems

Modified 1 models

2026.04.08.1Apr 8, 2026

Updated: advertisers_adgroupads, advertisers_adgroups, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_insertionorders, advertisers_lineitems, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_targetingtypes_assignedtargetingoptions, inventorysources, partners_targetingtypes_assignedtargetingoptions

2026.04.04.1Apr 4, 2026

Updated: advertisers_adgroupads, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_adgroups_youtubeassettypes_youtubeassetassociations, advertisers_insertionorders, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_lineitems_youtubeassettypes_youtubeassetassociations, advertisers_targetingtypes_assignedtargetingoptions, partners_targetingtypes_assignedtargetingoptions

2026.04.03.3Apr 3, 2026

Updated: advertisers, advertisers_adassets, advertisers_adgroupads, advertisers_adgroups, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_adgroups_youtubeassettypes_youtubeassetassociations, advertisers_campaigns, advertisers_channels, advertisers_channels_sites, advertisers_creatives, advertisers_insertionorders, advertisers_invoices, advertisers_lineitems, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_lineitems_youtubeassettypes_youtubeassetassociations, advertisers_locationlists, advertisers_locationlists_assignedlocations, advertisers_negativekeywordlists, advertisers_negativekeywordlists_negativekeywords, advertisers_targetingtypes_assignedtargetingoptions, combinedaudiences, custombiddingalgorithms, custombiddingalgorithms_rules, custombiddingalgorithms_scripts, customlists, firstpartyandpartneraudiences, floodlightgroups, floodlightgroups_floodlightactivities, googleaudiences, guaranteedorders, inventorysourcegroups, inventorysourcegroups_assignedinventorysources, inventorysources, partners, partners_channels, partners_channels_sites, partners_targetingtypes_assignedtargetingoptions, targetingtypes_targetingoptions, users

2026.04.03.1Apr 3, 2026

Updated: advertisers, advertisers_adassets, advertisers_adgroupads, advertisers_adgroups, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_adgroups_youtubeassettypes_youtubeassetassociations, advertisers_campaigns, advertisers_channels, advertisers_channels_sites, advertisers_creatives, advertisers_insertionorders, advertisers_invoices, advertisers_lineitems, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_lineitems_youtubeassettypes_youtubeassetassociations, advertisers_locationlists, advertisers_locationlists_assignedlocations, advertisers_negativekeywordlists, advertisers_negativekeywordlists_negativekeywords, advertisers_targetingtypes_assignedtargetingoptions, combinedaudiences, custombiddingalgorithms, custombiddingalgorithms_rules, custombiddingalgorithms_scripts, customlists, firstpartyandpartneraudiences, floodlightgroups, floodlightgroups_floodlightactivities, googleaudiences, guaranteedorders, inventorysourcegroups, inventorysourcegroups_assignedinventorysources, inventorysources, partners, partners_channels, partners_channels_sites, partners_targetingtypes_assignedtargetingoptions, targetingtypes_targetingoptions, users

2026.04.02.2Apr 2, 2026

Updated: advertisers_adgroupads, advertisers_adgroups, advertisers_insertionorders, advertisers_lineitems

Modified 1 models

2026.03.27.1Mar 27, 2026

Added: advertisers, advertisers_adassets, advertisers_adgroupads, advertisers_adgroups, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_adgroups_youtubeassettypes_youtubeassetassociations, advertisers_campaigns, advertisers_channels, advertisers_channels_sites, advertisers_creatives, advertisers_insertionorders, advertisers_invoices, advertisers_lineitems, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_lineitems_youtubeassettypes_youtubeassetassociations, advertisers_locationlists, advertisers_locationlists_assignedlocations, advertisers_negativekeywordlists, advertisers_negativekeywordlists_negativekeywords, advertisers_targetingtypes_assignedtargetingoptions, combinedaudiences, custombiddingalgorithms, custombiddingalgorithms_rules, custombiddingalgorithms_scripts, customlists, firstpartyandpartneraudiences, floodlightgroups, floodlightgroups_floodlightactivities, googleaudiences, guaranteedorders, inventorysourcegroups, inventorysourcegroups_assignedinventorysources, inventorysources, partners, partners_channels, partners_channels_sites, partners_targetingtypes_assignedtargetingoptions, targetingtypes_targetingoptions, users

04Stats

100 / 100

Downloads

Archive size

433.0 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 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

Repository

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

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#gcp #google-cloud #displayvideo #cloud #infrastructure