Gcp/displayvideo
@swamp/gcp/displayvideov2026.06.09.1
01README
Google Cloud displayvideo infrastructure models
02Release Notes
- Updated: advertisers, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_creatives, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_targetingtypes_assignedtargetingoptions, guaranteedorders, inventorysources, partners_targetingtypes_assignedtargetingoptions, advertisers_youtubeadgroups_targetingtypes_assignedtargetingoptions
03Models
advertisers.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| adServerConfig? | object | Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser. |
| billingConfig? | object | Required. The ID of a billing profile assigned to the advertiser. |
| containsEuPoliticalAds? | enum | 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 | Whether or not the advertiser is enabled for dynamic creatives. |
| dataAccessConfig? | object | 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 | Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| entityStatus? | enum | 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 | 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 | Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. |
| partnerId? | string | Required. Immutable. The unique ID of the partner that the advertiser belongs to. |
| prismaEnabled? | boolean | 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 | 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 | Description |
|---|---|---|
| identifier | string | The name of the advertisers |
fn update()
Update advertisers attributes
fn delete(identifier: string)
Delete the advertisers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the advertisers |
fn sync()
Sync advertisers state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List advertisers resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| partnerId? | string | Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn audit()
audit
fn edit_assigned_targeting_options(createRequests?: any, deleteRequests?: any)
edit assigned targeting options
| Argument | Type | Description |
|---|---|---|
| createRequests? | any | |
| deleteRequests? | any |
fn list_assigned_targeting_options()
list assigned targeting options
advertisers_adassets.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| adAsset? | object | Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. |
| advertiserId | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the adAssets |
fn sync()
Sync adAssets state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List adAssets resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE` |
| orderBy? | string | Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_create(adAssets?: any)
bulk create
| Argument | Type | Description |
|---|---|---|
| adAssets? | any |
fn upload(adAssetType?: any, filename?: any)
upload
| Argument | Type | Description |
|---|---|---|
| adAssetType? | any | |
| filename? | any |
advertisers_adgroupads.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| adGroupId? | string | Required. Immutable. The unique ID of the ad group that the ad belongs to. |
| adPolicy? | object | The policy approval status of an ad, indicating the approval decision. |
| advertiserId? | string | Output only. The unique ID of the advertiser the ad belongs to. |
| audioAd? | object | The webpage address that appears with the ad. |
| bumperAd? | object | The text on the call-to-action button. |
| dcmTrackingInfo? | object | Required. The DCM creative id. |
| demandGenCarouselAd? | object | Required. The business name shown on the ad. |
| demandGenImageAd? | object | Required. The business name shown on the ad. |
| demandGenProductAd? | object | Required. The business name shown on the ad. |
| demandGenVideoAd? | object | Required. The business name shown on the ad. |
| displayName? | string | Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. |
| displayVideoSourceAd? | object | The ID of the source creative. |
| entityStatus? | enum | Required. The entity status of the ad. |
| inStreamAd? | object | The text on the call-to-action button. |
| mastheadAd? | object | The duration of time the video will autoplay. |
| nonSkippableAd? | object | The text on the call-to-action button. |
| videoDiscoverAd? | object | First text line for the ad. |
| videoPerformanceAd? | object | 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 | Description |
|---|---|---|
| identifier | string | The name of the adGroupAds |
fn update()
Update adGroupAds attributes
fn delete(identifier: string)
Delete the adGroupAds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the adGroupAds |
fn sync()
Sync adGroupAds state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List adGroupAds resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_adgroups.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| adGroupFormat? | enum | Required. Immutable. The format of the ads in the ad group. |
| adGroupInventoryControl? | object | The inventory strategy. |
| advertiserId? | string | Output only. The unique ID of the advertiser the ad group belongs to. |
| bidStrategy? | object | 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 | Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes. |
| entityStatus? | enum | 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 | Required. Immutable. The unique ID of the line item that the ad group belongs to. |
| productFeedData? | object | Whether the product feed has opted-out of showing products. |
| targetingExpansion? | object | 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 | Description |
|---|---|---|
| identifier | string | The name of the adGroups |
fn update()
Update adGroups attributes
fn delete(identifier: string)
Delete the adGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the adGroups |
fn sync()
Sync adGroups state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List adGroups resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit_assigned_targeting_options(adGroupIds?: any, createRequests?: any, deleteRequests?: any)
bulk edit assigned targeting options
| Argument | Type | Description |
|---|---|---|
| adGroupIds? | any | |
| createRequests? | any | |
| deleteRequests? | any |
fn bulk_list_assigned_targeting_options()
bulk list assigned targeting options
advertisers_adgroups_targetingtypes_assignedtargetingoptions.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| ageRangeDetails? | object | 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 | Output only. The display name of the app category. |
| appDetails? | object | 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 | 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 | Required. The audio content type. |
| authorizedSellerStatusDetails? | object | Output only. The authorized seller status to target. |
| browserDetails? | object | Output only. The display name of the browser. |
| businessChainDetails? | object | Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". |
| carrierAndIspDetails? | object | Output only. The display name of the carrier or ISP. |
| categoryDetails? | object | Output only. The display name of the category. |
| channelDetails? | object | 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 | Output only. The content duration. |
| contentGenreDetails? | object | Output only. The display name of the content genre. |
| contentInstreamPositionDetails? | object | 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 | 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 | Output only. The content stream type. |
| contentThemeExclusionDetails? | object | Output only. An enum for the DV360 content theme classifier. |
| dayAndTimeDetails? | object | Required. The day of the week for this day and time targeting setting. |
| deviceMakeModelDetails? | object | Output only. The display name of the device make and model. |
| deviceTypeDetails? | object | Required. The display name of the device type. |
| digitalContentLabelExclusionDetails? | object | Required. The display name of the digital content label rating tier to be EXCLUDED. |
| environmentDetails? | object | Required. The serving environment. |
| exchangeDetails? | object | Required. The enum value for the exchange. |
| genderDetails? | object | Required. The gender of the audience. |
| geoRegionDetails? | object | Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| householdIncomeDetails? | object | Required. The household income of the audience. |
| inventorySourceDetails? | object | Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| inventorySourceGroupDetails? | object | Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| keywordDetails? | object | 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 | Output only. The display name of the language (e.g., "French"). |
| nativeContentPositionDetails? | object | Required. The content position. |
| negativeKeywordListDetails? | object | Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| omidDetails? | object | Required. The type of Open Measurement enabled inventory. |
| onScreenPositionDetails? | object | 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 | Output only. The display name of the operating system. |
| parentalStatusDetails? | object | Required. The parental status of the audience. |
| poiDetails? | object | Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. |
| proximityLocationListDetails? | object | 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 | Indicates if this option is being negatively targeted. |
| sensitiveCategoryExclusionDetails? | object | Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. |
| sessionPositionDetails? | object | The position where the ad will show in a session. |
| subExchangeDetails? | object | Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| targetingType? | enum | Output only. Identifies the type of this assigned targeting option. |
| thirdPartyVerifierDetails? | object | Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. |
| urlDetails? | object | Indicates if this option is being negatively targeted. |
| userRewardedContentDetails? | object | Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| videoPlayerSizeDetails? | object | Required. The video player size. |
| viewabilityDetails? | object | Required. The predicted viewability percentage. |
| youtubeChannelDetails? | object | The YouTube uploader channel id or the channel code of a YouTube channel. |
| youtubeChannelPackDetails? | object | Required. The ID of the YouTube channel pack. |
| youtubeVideoDetails? | object | Indicates if this option is being negatively targeted. |
| advertiserId | string | Required. The ID of the advertiser the ad group belongs to. |
| adGroupId | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn delete(identifier: string)
Delete the assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn sync()
Sync assignedTargetingOptions state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assignedTargetingOptions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_adgroups_youtubeassettypes_youtubeassetassociations.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| linkedYoutubeAsset? | object | Required. ID of the affiliate location chain. |
| name? | string | 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 | Required. The type of YouTube asset associated with the resource. |
| advertiserId | string | Required. The ID of the advertiser that the linked entity belongs to. |
| adGroupId | string | The ID of an ad group. |
| linkedEntity_lineItemId? | string | The ID of a line item. |
fn create()
Create a youtubeAssetAssociations
fn get(identifier: string)
Get a youtubeAssetAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the youtubeAssetAssociations |
fn delete(identifier: string)
Delete the youtubeAssetAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the youtubeAssetAssociations |
fn sync()
Sync youtubeAssetAssociations state from GCP
fn list(linkedEntity_lineItemId?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List youtubeAssetAssociations resources
| Argument | Type | Description |
|---|---|---|
| linkedEntity_lineItemId? | string | The ID of a line item. |
| orderBy? | string | Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_campaigns.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | Output only. The unique ID of the advertiser the campaign belongs to. |
| campaignBudgets? | array | 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 | 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 | Required. The type of the campaign goal. |
| displayName? | string | Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| entityStatus? | enum | 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 | 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 | Description |
|---|---|---|
| identifier | string | The name of the campaigns |
fn update()
Update campaigns attributes
fn delete(identifier: string)
Delete the campaigns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the campaigns |
fn sync()
Sync campaigns state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List campaigns resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_channels.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | The ID of the advertiser that owns the channel. |
| displayName? | string | Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| partnerId? | string | The ID of the partner that owns the channel. |
fn create()
Create a channels
fn get(identifier: string)
Get a channels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the channels |
fn update()
Update channels attributes
fn sync()
Sync channels state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List channels resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that owns the channels. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_channels_sites.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| urlOrAppId? | string | Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| advertiserId | string | The ID of the advertiser that owns the parent channel. |
| channelId | string | Required. The ID of the parent channel in which the site will be created. |
| partnerId? | string | The ID of the partner that owns the parent channel. |
fn create()
Create a sites
fn get(identifier: string)
Get a sites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sites |
fn delete(identifier: string)
Delete the sites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sites |
fn sync()
Sync sites state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List sites resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that owns the parent channel. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit(advertiserId?: any, createdSites?: any, deletedSites?: any, partnerId?: any)
bulk edit
| Argument | Type | Description |
|---|---|---|
| advertiserId? | any | |
| createdSites? | any | |
| deletedSites? | any | |
| partnerId? | any |
fn replace(advertiserId?: any, newSites?: any, partnerId?: any)
replace
| Argument | Type | Description |
|---|---|---|
| advertiserId? | any | |
| newSites? | any | |
| partnerId? | any |
advertisers_creatives.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| additionalDimensions? | array | The height in pixels. |
| advertiserId? | string | Output only. The unique ID of the advertiser the creative belongs to. |
| appendedTag? | string | Optional. Third-party HTML tracking tag to be appended to the creative tag. |
| assets? | array | The asset content. For uploaded assets, the content is the serving path. |
| cmTrackingAd? | object | Optional. The ad ID of the campaign manager 360 tracking Ad. |
| companionCreativeIds? | array | 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 | Required. The name of the counter event. |
| creativeType? | enum | Required. Immutable. The type of the creative. |
| dimensions? | object | The height in pixels. |
| displayName? | string | Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| entityStatus? | enum | Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| exitEvents? | array | 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 | 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 | 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 | Required. Indicates where the creative is hosted. |
| iasCampaignMonitoring? | boolean | 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 | 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 | 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 | Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| obaIcon? | object | 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 | Optional. The offset in percentage of the audio or video duration. |
| requireHtml5? | boolean | 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 | 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 | 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 | 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 | Optional. The offset in percentage of the audio or video duration. |
| skippable? | boolean | 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 | 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 | Optional. The type of interaction needs to be tracked by the tracking URL |
| timerEvents? | array | Required. The name of the timer event. |
| trackerUrls? | array | 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 | Optional. The unique creative identifier. |
| vastTagUrl? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the creatives |
fn update()
Update creatives attributes
fn delete(identifier: string)
Delete the creatives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the creatives |
fn sync()
Sync creatives state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List creatives resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource\'s field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_insertionorders.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | Output only. The unique ID of the advertiser the insertion order belongs to. |
| bidStrategy? | object | 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 | 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 | Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| displayName? | string | Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| entityStatus? | enum | 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 | 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 | Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. |
| integrationDetails? | object | Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. |
| kpi? | object | 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 | Optional. Required. The optimization objective of the insertion order. |
| pacing? | object | Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. |
| partnerCosts? | array | Required. The type of the partner cost. |
fn create()
Create a insertionOrders
fn get(identifier: string)
Get a insertionOrders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the insertionOrders |
fn update()
Update insertionOrders attributes
fn delete(identifier: string)
Delete the insertionOrders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the insertionOrders |
fn sync()
Sync insertionOrders state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List insertionOrders resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_invoices.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a invoices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the invoices |
fn sync()
Sync invoices state from GCP
fn list(issueMonth?: string, loiSapinInvoiceType?: string, pageSize?: number, maxPages?: number)
List invoices resources
| Argument | Type | Description |
|---|---|---|
| issueMonth? | string | The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. |
| loiSapinInvoiceType? | string | Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn lookup_invoice_currency()
lookup invoice currency
advertisers_lineitems.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | Output only. The unique ID of the advertiser the line item belongs to. |
| bidStrategy? | object | 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 | 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 | 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 | Required. The ID of the Floodlight activity. |
| creativeIds? | array | The IDs of the creatives associated with the line item. |
| demandGenSettings? | object | 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 | Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| entityStatus? | enum | 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 | Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. |
| flight? | object | 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 | 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 | Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
| integrationDetails? | object | Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. |
| lineItemType? | enum | Required. Immutable. The type of the line item. |
| mobileApp? | object | 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 | 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 | Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. |
| partnerCosts? | array | Required. The type of the partner cost. |
| partnerRevenueModel? | object | 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 | 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 | 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 | Description |
|---|---|---|
| identifier | string | The name of the lineItems |
fn update()
Update lineItems attributes
fn delete(identifier: string)
Delete the lineItems
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the lineItems |
fn sync()
Sync lineItems state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List lineItems resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit_assigned_targeting_options(createRequests?: any, deleteRequests?: any, lineItemIds?: any)
bulk edit assigned targeting options
| Argument | Type | Description |
|---|---|---|
| createRequests? | any | |
| deleteRequests? | any | |
| lineItemIds? | any |
fn bulk_list_assigned_targeting_options()
bulk list assigned targeting options
fn bulk_update(lineItemIds?: any, targetLineItem?: any, updateMask?: any)
bulk update
| Argument | Type | Description |
|---|---|---|
| lineItemIds? | any | |
| targetLineItem? | any | |
| updateMask? | any |
fn duplicate(containsEuPoliticalAds?: any, targetDisplayName?: any)
duplicate
| Argument | Type | Description |
|---|---|---|
| containsEuPoliticalAds? | any | |
| targetDisplayName? | any |
advertisers_lineitems_targetingtypes_assignedtargetingoptions.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| ageRangeDetails? | object | 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 | Output only. The display name of the app category. |
| appDetails? | object | 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 | 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 | Required. The audio content type. |
| authorizedSellerStatusDetails? | object | Output only. The authorized seller status to target. |
| browserDetails? | object | Output only. The display name of the browser. |
| businessChainDetails? | object | Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". |
| carrierAndIspDetails? | object | Output only. The display name of the carrier or ISP. |
| categoryDetails? | object | Output only. The display name of the category. |
| channelDetails? | object | 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 | Output only. The content duration. |
| contentGenreDetails? | object | Output only. The display name of the content genre. |
| contentInstreamPositionDetails? | object | 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 | 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 | Output only. The content stream type. |
| contentThemeExclusionDetails? | object | Output only. An enum for the DV360 content theme classifier. |
| dayAndTimeDetails? | object | Required. The day of the week for this day and time targeting setting. |
| deviceMakeModelDetails? | object | Output only. The display name of the device make and model. |
| deviceTypeDetails? | object | Required. The display name of the device type. |
| digitalContentLabelExclusionDetails? | object | Required. The display name of the digital content label rating tier to be EXCLUDED. |
| environmentDetails? | object | Required. The serving environment. |
| exchangeDetails? | object | Required. The enum value for the exchange. |
| genderDetails? | object | Required. The gender of the audience. |
| geoRegionDetails? | object | Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| householdIncomeDetails? | object | Required. The household income of the audience. |
| inventorySourceDetails? | object | Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| inventorySourceGroupDetails? | object | Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| keywordDetails? | object | 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 | Output only. The display name of the language (e.g., "French"). |
| nativeContentPositionDetails? | object | Required. The content position. |
| negativeKeywordListDetails? | object | Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| omidDetails? | object | Required. The type of Open Measurement enabled inventory. |
| onScreenPositionDetails? | object | 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 | Output only. The display name of the operating system. |
| parentalStatusDetails? | object | Required. The parental status of the audience. |
| poiDetails? | object | Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. |
| proximityLocationListDetails? | object | 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 | Indicates if this option is being negatively targeted. |
| sensitiveCategoryExclusionDetails? | object | Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. |
| sessionPositionDetails? | object | The position where the ad will show in a session. |
| subExchangeDetails? | object | Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| targetingType? | enum | Output only. Identifies the type of this assigned targeting option. |
| thirdPartyVerifierDetails? | object | Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. |
| urlDetails? | object | Indicates if this option is being negatively targeted. |
| userRewardedContentDetails? | object | Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| videoPlayerSizeDetails? | object | Required. The video player size. |
| viewabilityDetails? | object | Required. The predicted viewability percentage. |
| youtubeChannelDetails? | object | The YouTube uploader channel id or the channel code of a YouTube channel. |
| youtubeChannelPackDetails? | object | Required. The ID of the YouTube channel pack. |
| youtubeVideoDetails? | object | Indicates if this option is being negatively targeted. |
| advertiserId | string | Required. The ID of the advertiser the line item belongs to. |
| lineItemId | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn delete(identifier: string)
Delete the assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn sync()
Sync assignedTargetingOptions state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assignedTargetingOptions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_lineitems_youtubeassettypes_youtubeassetassociations.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| linkedYoutubeAsset? | object | Required. ID of the affiliate location chain. |
| name? | string | 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 | Required. The type of YouTube asset associated with the resource. |
| advertiserId | string | Required. The ID of the advertiser that the linked entity belongs to. |
| lineItemId | string | The ID of a line item. |
| linkedEntity_adGroupId? | string | The ID of an ad group. |
fn create()
Create a youtubeAssetAssociations
fn get(identifier: string)
Get a youtubeAssetAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the youtubeAssetAssociations |
fn delete(identifier: string)
Delete the youtubeAssetAssociations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the youtubeAssetAssociations |
fn sync()
Sync youtubeAssetAssociations state from GCP
fn list(linkedEntity_adGroupId?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List youtubeAssetAssociations resources
| Argument | Type | Description |
|---|---|---|
| linkedEntity_adGroupId? | string | The ID of an ad group. |
| orderBy? | string | Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_locationlists.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | Required. Immutable. The unique ID of the advertiser the location list belongs to. |
| displayName? | string | Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| locationType? | enum | 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 | Description |
|---|---|---|
| identifier | string | The name of the locationLists |
fn update()
Update locationLists attributes
fn sync()
Sync locationLists state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List locationLists resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_locationlists_assignedlocations.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| targetingOptionId? | string | Required. The ID of the targeting option assigned to the location list. |
| advertiserId | string | Required. The ID of the DV360 advertiser to which the location list belongs. |
| locationListId | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the assignedLocations |
fn delete(identifier: string)
Delete the assignedLocations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedLocations |
fn sync()
Sync assignedLocations state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assignedLocations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit(createdAssignedLocations?: any, deletedAssignedLocations?: any)
bulk edit
| Argument | Type | Description |
|---|---|---|
| createdAssignedLocations? | any | |
| deletedAssignedLocations? | any |
advertisers_manualtriggers.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| activationDurationMinutes? | string | Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated. |
| advertiserId? | string | Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to. |
| displayName? | string | Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes. |
fn create(waitForReady?: boolean)
Create a manualTriggers
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a manualTriggers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the manualTriggers |
fn update(waitForReady?: boolean)
Update manualTriggers attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync()
Sync manualTriggers state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List manualTriggers resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by manual trigger fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `displayName` * `state` Examples: * All active manual triggers under an advertiser: `state="ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `state` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn activate()
activate
fn deactivate()
deactivate
advertisers_negativekeywordlists.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | Output only. The unique ID of the advertiser the negative keyword list belongs to. |
| displayName? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the negativeKeywordLists |
fn update()
Update negativeKeywordLists attributes
fn delete(identifier: string)
Delete the negativeKeywordLists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the negativeKeywordLists |
fn sync()
Sync negativeKeywordLists state from GCP
fn list(pageSize?: number, maxPages?: number)
List negativeKeywordLists resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_negativekeywordlists_negativekeywords.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| keywordValue? | string | 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 | Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. |
| negativeKeywordListId | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the negativeKeywords |
fn delete(identifier: string)
Delete the negativeKeywords
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the negativeKeywords |
fn sync()
Sync negativeKeywords state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List negativeKeywords resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit(createdNegativeKeywords?: any, deletedNegativeKeywords?: any)
bulk edit
| Argument | Type | Description |
|---|---|---|
| createdNegativeKeywords? | any | |
| deletedNegativeKeywords? | any |
fn replace(newNegativeKeywords?: any)
replace
| Argument | Type | Description |
|---|---|---|
| newNegativeKeywords? | any |
advertisers_targetingtypes_assignedtargetingoptions.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| ageRangeDetails? | object | 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 | Output only. The display name of the app category. |
| appDetails? | object | 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 | 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 | Required. The audio content type. |
| authorizedSellerStatusDetails? | object | Output only. The authorized seller status to target. |
| browserDetails? | object | Output only. The display name of the browser. |
| businessChainDetails? | object | Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". |
| carrierAndIspDetails? | object | Output only. The display name of the carrier or ISP. |
| categoryDetails? | object | Output only. The display name of the category. |
| channelDetails? | object | 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 | Output only. The content duration. |
| contentGenreDetails? | object | Output only. The display name of the content genre. |
| contentInstreamPositionDetails? | object | 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 | 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 | Output only. The content stream type. |
| contentThemeExclusionDetails? | object | Output only. An enum for the DV360 content theme classifier. |
| dayAndTimeDetails? | object | Required. The day of the week for this day and time targeting setting. |
| deviceMakeModelDetails? | object | Output only. The display name of the device make and model. |
| deviceTypeDetails? | object | Required. The display name of the device type. |
| digitalContentLabelExclusionDetails? | object | Required. The display name of the digital content label rating tier to be EXCLUDED. |
| environmentDetails? | object | Required. The serving environment. |
| exchangeDetails? | object | Required. The enum value for the exchange. |
| genderDetails? | object | Required. The gender of the audience. |
| geoRegionDetails? | object | Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| householdIncomeDetails? | object | Required. The household income of the audience. |
| inventorySourceDetails? | object | Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| inventorySourceGroupDetails? | object | Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| keywordDetails? | object | 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 | Output only. The display name of the language (e.g., "French"). |
| nativeContentPositionDetails? | object | Required. The content position. |
| negativeKeywordListDetails? | object | Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| omidDetails? | object | Required. The type of Open Measurement enabled inventory. |
| onScreenPositionDetails? | object | 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 | Output only. The display name of the operating system. |
| parentalStatusDetails? | object | Required. The parental status of the audience. |
| poiDetails? | object | Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. |
| proximityLocationListDetails? | object | 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 | Indicates if this option is being negatively targeted. |
| sensitiveCategoryExclusionDetails? | object | Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. |
| sessionPositionDetails? | object | The position where the ad will show in a session. |
| subExchangeDetails? | object | Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| targetingType? | enum | Output only. Identifies the type of this assigned targeting option. |
| thirdPartyVerifierDetails? | object | Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. |
| urlDetails? | object | Indicates if this option is being negatively targeted. |
| userRewardedContentDetails? | object | Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| videoPlayerSizeDetails? | object | Required. The video player size. |
| viewabilityDetails? | object | Required. The predicted viewability percentage. |
| youtubeChannelDetails? | object | The YouTube uploader channel id or the channel code of a YouTube channel. |
| youtubeChannelPackDetails? | object | Required. The ID of the YouTube channel pack. |
| youtubeVideoDetails? | object | Indicates if this option is being negatively targeted. |
| advertiserId | string | Required. The ID of the advertiser. |
fn create()
Create a assignedTargetingOptions
fn get(identifier: string)
Get a assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn delete(identifier: string)
Delete the assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn sync()
Sync assignedTargetingOptions state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assignedTargetingOptions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_youtubeadgroupads.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a youtubeAdGroupAds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the youtubeAdGroupAds |
fn sync()
Sync youtubeAdGroupAds state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List youtubeAdGroupAds resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by custom YouTube ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
advertisers_youtubeadgroups.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a youtubeAdGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the youtubeAdGroups |
fn sync()
Sync youtubeAdGroups state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List youtubeAdGroups resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_list_ad_group_assigned_targeting_options()
bulk list ad group assigned targeting options
advertisers_youtubeadgroups_targetingtypes_assignedtargetingoptions.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn sync()
Sync assignedTargetingOptions state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assignedTargetingOptions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
combinedaudiences.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a combinedAudiences
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the combinedAudiences |
fn sync()
Sync combinedAudiences state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List combinedAudiences resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the fetched combined audiences. |
| filter? | string | Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that has access to the fetched combined audiences. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
custombiddingalgorithms.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. |
| customBiddingAlgorithmType? | enum | Required. Immutable. The type of custom bidding algorithm. |
| displayName? | string | Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| entityStatus? | enum | 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 | Immutable. The unique ID of the partner that owns the custom bidding algorithm. |
| sharedAdvertiserIds? | array | 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 | 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 | Description |
|---|---|---|
| identifier | string | The name of the customBiddingAlgorithms |
fn update()
Update customBiddingAlgorithms attributes
fn sync()
Sync customBiddingAlgorithms state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List customBiddingAlgorithms resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the DV360 advertiser that has access to the custom bidding algorithm. |
| filter? | string | Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the DV360 partner that has access to the custom bidding algorithm. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn upload_rules()
upload rules
fn upload_script()
upload script
custombiddingalgorithms_rules.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| customBiddingAlgorithmId? | string | Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. |
| error? | object | The type of error. |
| rules? | object | 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 | The ID of the advertiser that owns the parent custom bidding algorithm. |
| partnerId? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the rules |
fn sync()
Sync rules state from GCP
fn list(advertiserId?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List rules resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that owns the parent custom bidding algorithm. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that owns the parent custom bidding algorithm. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
custombiddingalgorithms_scripts.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| customBiddingAlgorithmId? | string | Output only. The unique ID of the custom bidding algorithm the script belongs to. |
| script? | object | 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 | The ID of the advertiser that owns the parent custom bidding algorithm. |
| partnerId? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the scripts |
fn sync()
Sync scripts state from GCP
fn list(advertiserId?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List scripts resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that owns the parent custom bidding algorithm. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
customlists.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a customLists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customLists |
fn sync()
Sync customLists state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List customLists resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the DV360 advertiser that has access to the fetched custom lists. |
| filter? | string | Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
firstandthirdpartyaudiences.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| appId? | string | 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 | The type of the audience. |
| contactInfoList? | object | Represents consent for ad personalization. |
| description? | string | The user-provided description of the audience. Only applicable to first party audiences. |
| displayName? | string | The display name of the first and third party audience. |
| firstAndThirdPartyAudienceType? | enum | Whether the audience is a first or third party audience. |
| membershipDurationDays? | string | 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 | Represents consent for ad personalization. |
| advertiserId? | string | Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created. |
fn create()
Create a firstAndThirdPartyAudiences
fn get(identifier: string)
Get a firstAndThirdPartyAudiences
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the firstAndThirdPartyAudiences |
fn update()
Update firstAndThirdPartyAudiences attributes
fn sync()
Sync firstAndThirdPartyAudiences state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List firstAndThirdPartyAudiences resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the fetched first and third party audiences. |
| filter? | string | Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that has access to the fetched first and third party audiences. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn edit_customer_match_members(addedContactInfoList?: any, addedMobileDeviceIdList?: any, advertiserId?: any, removedContactInfoList?: any, removedMobileDeviceIdList?: any)
edit customer match members
| Argument | Type | Description |
|---|---|---|
| addedContactInfoList? | any | |
| addedMobileDeviceIdList? | any | |
| advertiserId? | any | |
| removedContactInfoList? | any | |
| removedMobileDeviceIdList? | any |
firstpartyandpartneraudiences.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| appId? | string | 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 | Immutable. The type of the audience. |
| contactInfoList? | object | Represents consent for ad personalization. |
| description? | string | Optional. The user-provided description of the audience. Only applicable to first party audiences. |
| displayName? | string | Optional. The display name of the first party and partner audience. |
| firstPartyAndPartnerAudienceId? | string | Identifier. The unique ID of the first party and partner audience. Assigned by the system. |
| membershipDurationDays? | string | 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 | Represents consent for ad personalization. |
| advertiserId? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the firstPartyAndPartnerAudiences |
fn update()
Update firstPartyAndPartnerAudiences attributes
fn sync()
Sync firstPartyAndPartnerAudiences state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List firstPartyAndPartnerAudiences resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the fetched first party and partner audiences. |
| filter? | string | Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first party and partner audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that has access to the fetched first party and partner audiences. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn edit_customer_match_members(addedContactInfoList?: any, addedMobileDeviceIdList?: any, advertiserId?: any, removedContactInfoList?: any, removedMobileDeviceIdList?: any)
edit customer match members
| Argument | Type | Description |
|---|---|---|
| addedContactInfoList? | any | |
| addedMobileDeviceIdList? | any | |
| advertiserId? | any | |
| removedContactInfoList? | any | |
| removedMobileDeviceIdList? | any |
floodlightgroups.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| activeViewConfig? | object | Required. The display name of the custom metric. |
| customVariables? | record | 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 | Required. The display name of the Floodlight group. |
| floodlightGroupId? | string | Output only. The unique ID of the Floodlight group. Assigned by the system. |
| lookbackWindow? | object | Lookback window, in days, from the last time a given user clicked on one of your ads. |
| name? | string | Output only. The resource name of the Floodlight group. |
| webTagType? | enum | Required. The web tag type enabled for the Floodlight group. |
fn get(identifier: string)
Get a floodlightGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the floodlightGroups |
fn update()
Update floodlightGroups attributes
fn sync()
Sync floodlightGroups state from GCP
floodlightgroups_floodlightactivities.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a floodlightActivities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the floodlightActivities |
fn sync()
Sync floodlightActivities state from GCP
fn list(orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List floodlightActivities resources
| Argument | Type | Description |
|---|---|---|
| orderBy? | string | Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | Required. The ID of the partner through which the Floodlight activities are being accessed. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
googleaudiences.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a googleAudiences
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the googleAudiences |
fn sync()
Sync googleAudiences state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List googleAudiences resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the fetched Google audiences. |
| filter? | string | Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that has access to the fetched Google audiences. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
guaranteedorders.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| defaultCampaignId? | string | The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser. |
| displayName? | string | Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| exchange? | enum | Required. Immutable. The exchange where the guaranteed order originated. |
| publisherName? | string | Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| readAccessInherited? | boolean | 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 | 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 | The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. |
| readWritePartnerId? | string | The partner with read/write access to the guaranteed order. |
| status? | object | 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 | The ID of the advertiser that the request is being made within. |
| partnerId? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the guaranteedOrders |
fn update()
Update guaranteedOrders attributes
fn sync()
Sync guaranteedOrders state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List guaranteedOrders resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the guaranteed order. |
| filter? | string | Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| partnerId? | string | The ID of the partner that has access to the guaranteed order. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn edit_guaranteed_order_read_accessors(addedAdvertisers?: any, partnerId?: any, readAccessInherited?: any, removedAdvertisers?: any)
edit guaranteed order read accessors
| Argument | Type | Description |
|---|---|---|
| addedAdvertisers? | any | |
| partnerId? | any | |
| readAccessInherited? | any | |
| removedAdvertisers? | any |
inventorysourcegroups.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| displayName? | string | Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| advertiserId? | string | The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group. |
| partnerId? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the inventorySourceGroups |
fn update()
Update inventorySourceGroups attributes
fn delete(identifier: string)
Delete the inventorySourceGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the inventorySourceGroups |
fn sync()
Sync inventorySourceGroups state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List inventorySourceGroups resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. |
| filter? | string | Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| partnerId? | string | The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
inventorysourcegroups_assignedinventorysources.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| inventorySourceId? | string | Required. The ID of the inventory source entity being targeted. |
| inventorySourceGroupId | string | Required. The ID of the inventory source group to which the assignment will be assigned. |
| advertiserId? | string | 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 | 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 | Description |
|---|---|---|
| identifier | string | The name of the assignedInventorySources |
fn delete(identifier: string)
Delete the assignedInventorySources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedInventorySources |
fn sync()
Sync assignedInventorySources state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List assignedInventorySources resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source. |
| filter? | string | Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| partnerId? | string | The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit(advertiserId?: any, createdAssignedInventorySources?: any, deletedAssignedInventorySources?: any, partnerId?: any)
bulk edit
| Argument | Type | Description |
|---|---|---|
| advertiserId? | any | |
| createdAssignedInventorySources? | any | |
| deletedAssignedInventorySources? | any | |
| partnerId? | any |
inventorysources.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| commitment? | enum | Whether the inventory source has a guaranteed or non-guaranteed delivery. |
| creativeConfigs? | array | 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 | 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 | 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 | The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| exchange? | enum | The exchange to which the inventory source belongs. |
| guaranteedOrderId? | string | Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`. |
| inventorySourceType? | enum | Denotes the type of the inventory source. |
| publisherName? | string | The publisher/seller name of the inventory source. |
| rateDetails? | object | 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 | The IDs of the advertisers. |
| status? | object | 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 | Required. The upper bound of a time range, inclusive. |
| advertiserId? | string | The ID of the advertiser that the request is being made within. |
| partnerId? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the inventorySources |
fn update()
Update inventorySources attributes
fn sync()
Sync inventorySources state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, partnerId?: string, maxPages?: number)
List inventorySources resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that has access to the inventory source. |
| filter? | string | Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| partnerId? | string | The ID of the partner that has access to the inventory source. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn edit_inventory_source_read_write_accessors(advertisersUpdate?: any, assignPartner?: any, partnerId?: any)
edit inventory source read write accessors
| Argument | Type | Description |
|---|---|---|
| advertisersUpdate? | any | |
| assignPartner? | any | |
| partnerId? | any |
partners.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a partners
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the partners |
fn sync()
Sync partners state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List partners resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn edit_assigned_targeting_options(createRequests?: any, deleteRequests?: any)
edit assigned targeting options
| Argument | Type | Description |
|---|---|---|
| createRequests? | any | |
| deleteRequests? | any |
partners_channels.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| advertiserId? | string | The ID of the advertiser that owns the channel. |
| displayName? | string | Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| partnerId? | string | The ID of the partner that owns the channel. |
fn create()
Create a channels
fn get(identifier: string)
Get a channels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the channels |
fn update()
Update channels attributes
fn sync()
Sync channels state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List channels resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that owns the channels. |
| filter? | string | Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
partners_channels_sites.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| urlOrAppId? | string | Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. |
| partnerId | string | The ID of the partner that owns the parent channel. |
| channelId | string | Required. The ID of the parent channel in which the site will be created. |
| advertiserId? | string | The ID of the advertiser that owns the parent channel. |
fn create()
Create a sites
fn get(identifier: string)
Get a sites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sites |
fn delete(identifier: string)
Delete the sites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sites |
fn sync()
Sync sites state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List sites resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | The ID of the advertiser that owns the parent channel. |
| filter? | string | Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit(advertiserId?: any, createdSites?: any, deletedSites?: any, partnerId?: any)
bulk edit
| Argument | Type | Description |
|---|---|---|
| advertiserId? | any | |
| createdSites? | any | |
| deletedSites? | any | |
| partnerId? | any |
fn replace(advertiserId?: any, newSites?: any, partnerId?: any)
replace
| Argument | Type | Description |
|---|---|---|
| advertiserId? | any | |
| newSites? | any | |
| partnerId? | any |
partners_targetingtypes_assignedtargetingoptions.tsv2026.06.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| ageRangeDetails? | object | 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 | Output only. The display name of the app category. |
| appDetails? | object | 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 | 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 | Required. The audio content type. |
| authorizedSellerStatusDetails? | object | Output only. The authorized seller status to target. |
| browserDetails? | object | Output only. The display name of the browser. |
| businessChainDetails? | object | Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". |
| carrierAndIspDetails? | object | Output only. The display name of the carrier or ISP. |
| categoryDetails? | object | Output only. The display name of the category. |
| channelDetails? | object | 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 | Output only. The content duration. |
| contentGenreDetails? | object | Output only. The display name of the content genre. |
| contentInstreamPositionDetails? | object | 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 | 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 | Output only. The content stream type. |
| contentThemeExclusionDetails? | object | Output only. An enum for the DV360 content theme classifier. |
| dayAndTimeDetails? | object | Required. The day of the week for this day and time targeting setting. |
| deviceMakeModelDetails? | object | Output only. The display name of the device make and model. |
| deviceTypeDetails? | object | Required. The display name of the device type. |
| digitalContentLabelExclusionDetails? | object | Required. The display name of the digital content label rating tier to be EXCLUDED. |
| environmentDetails? | object | Required. The serving environment. |
| exchangeDetails? | object | Required. The enum value for the exchange. |
| genderDetails? | object | Required. The gender of the audience. |
| geoRegionDetails? | object | Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
| householdIncomeDetails? | object | Required. The household income of the audience. |
| inventorySourceDetails? | object | Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. |
| inventorySourceGroupDetails? | object | Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. |
| keywordDetails? | object | 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 | Output only. The display name of the language (e.g., "French"). |
| nativeContentPositionDetails? | object | Required. The content position. |
| negativeKeywordListDetails? | object | Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. |
| omidDetails? | object | Required. The type of Open Measurement enabled inventory. |
| onScreenPositionDetails? | object | 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 | Output only. The display name of the operating system. |
| parentalStatusDetails? | object | Required. The parental status of the audience. |
| poiDetails? | object | Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. |
| proximityLocationListDetails? | object | 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 | Indicates if this option is being negatively targeted. |
| sensitiveCategoryExclusionDetails? | object | Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. |
| sessionPositionDetails? | object | The position where the ad will show in a session. |
| subExchangeDetails? | object | Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. |
| targetingType? | enum | Output only. Identifies the type of this assigned targeting option. |
| thirdPartyVerifierDetails? | object | Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. |
| urlDetails? | object | Indicates if this option is being negatively targeted. |
| userRewardedContentDetails? | object | Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. |
| videoPlayerSizeDetails? | object | Required. The video player size. |
| viewabilityDetails? | object | Required. The predicted viewability percentage. |
| youtubeChannelDetails? | object | The YouTube uploader channel id or the channel code of a YouTube channel. |
| youtubeChannelPackDetails? | object | Required. The ID of the YouTube channel pack. |
| youtubeVideoDetails? | object | Indicates if this option is being negatively targeted. |
| partnerId | string | Required. The ID of the partner. |
fn create()
Create a assignedTargetingOptions
fn get(identifier: string)
Get a assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn delete(identifier: string)
Delete the assignedTargetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assignedTargetingOptions |
fn sync()
Sync assignedTargetingOptions state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List assignedTargetingOptions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
targetingtypes_targetingoptions.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a targetingOptions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetingOptions |
fn sync()
Sync targetingOptions state from GCP
fn list(advertiserId?: string, filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List targetingOptions resources
| Argument | Type | Description |
|---|---|---|
| advertiserId? | string | Required. The Advertiser this request is being made in the context of. |
| filter? | string | Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn search(advertiserId?: any, businessChainSearchTerms?: any, geoRegionSearchTerms?: any, pageSize?: any, pageToken?: any, poiSearchTerms?: any)
search
| Argument | Type | Description |
|---|---|---|
| advertiserId? | any | |
| businessChainSearchTerms? | any | |
| geoRegionSearchTerms? | any | |
| pageSize? | any | |
| pageToken? | any | |
| poiSearchTerms? | any |
users.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| displayName? | string | Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| email? | string | Required. Immutable. The email address used to identify the user. |
fn create()
Create a users
fn get(identifier: string)
Get a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn update()
Update users attributes
fn delete(identifier: string)
Delete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn sync()
Sync users state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List users resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |
| orderBy? | string | Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. |
| pageSize? | number | Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn bulk_edit_assigned_user_roles(createdAssignedUserRoles?: any, deletedAssignedUserRoles?: any)
bulk edit assigned user roles
| Argument | Type | Description |
|---|---|---|
| createdAssignedUserRoles? | any | |
| deletedAssignedUserRoles? | any |
04Previous Versions
2026.06.08.2Jun 8, 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, advertisers_manualtriggers, advertisers_youtubeadgroupads, advertisers_youtubeadgroups, advertisers_youtubeadgroups_targetingtypes_assignedtargetingoptions, firstandthirdpartyaudiences
2026.06.07.1Jun 7, 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, advertisers_manualtriggers, advertisers_youtubeadgroupads, advertisers_youtubeadgroups, advertisers_youtubeadgroups_targetingtypes_assignedtargetingoptions, firstandthirdpartyaudiences
2026.06.05.1Jun 5, 2026
- Added: advertisers_manualtriggers, advertisers_youtubeadgroupads, advertisers_youtubeadgroups, advertisers_youtubeadgroups_targetingtypes_assignedtargetingoptions, firstandthirdpartyaudiences
2026.06.04.1Jun 4, 2026
- Updated: advertisers_adgroups, advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_lineitems, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_targetingtypes_assignedtargetingoptions, partners_targetingtypes_assignedtargetingoptions
2026.05.26.1May 26, 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.05.25.2May 25, 2026
- Updated: advertisers, combinedaudiences, custombiddingalgorithms, customlists, firstpartyandpartneraudiences, googleaudiences, guaranteedorders, inventorysourcegroups, inventorysources, partners, users
Modified 1 models
2026.05.24.1May 24, 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.05.21.2May 21, 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.05.21.1May 21, 2026
2026.05.20.1May 20, 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.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.09.1May 10, 2026
- Updated: advertisers_adgroups_targetingtypes_assignedtargetingoptions, advertisers_lineitems_targetingtypes_assignedtargetingoptions, advertisers_targetingtypes_assignedtargetingoptions, partners_targetingtypes_assignedtargetingoptions
Modified 1 models
2026.04.23.1Apr 23, 2026
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
05Stats
A
100 / 100
Downloads
1
Archive size
798.8 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels