We can't find the internet
Attempting to reconnect
Something went wrong!
Hang in there while we get back on track
Google Display & Video 360
Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items. This OpenAPI specification was generated from the official Google API Discovery Document. All endpoints require authentication via OAuth 2.0 or API Key unless otherwise specified.
Capabilities (172)
List advertisers negativeKeywordLists
Lists negative keyword lists based on a given advertiser id.
displayvideo_advertisers_negative_keyword_lists_list(advertiserId, pageSize?, pageToken?) -> {negativeKeywordLists, nextPageToken}
List advertisers
Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
displayvideo_advertisers_list(filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {advertisers, nextPageToken}
Uploadscript customBiddingAlgorithms
Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.
displayvideo_custom_bidding_algorithms_upload_script(customBiddingAlgorithmId, advertiserId?, partnerId?) -> {resourceName}
Upload advertisers assets
Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).
displayvideo_advertisers_assets_upload(advertiserId, filename?) -> {asset}
List partners
Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
displayvideo_partners_list(filter?, orderBy?, pageSize?, pageToken?) -> {nextPageToken, partners}
List inventorySourceGroups assignedInventorySources
Lists inventory sources assigned to an inventory source group.
displayvideo_inventory_source_groups_assigned_inventory_sources_list(inventorySourceGroupId, advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {assignedInventorySources, nextPageToken}
Delete advertisers targetingTypes assignedTargetingOptions
Deletes an assigned targeting option from an advertiser.
displayvideo_advertisers_targeting_types_assigned_targeting_options_delete(advertiserId, assignedTargetingOptionId, targetingType) -> {}
List partners channels
Lists channels for a partner or advertiser.
displayvideo_partners_channels_list(partnerId, advertiserId?, filter?, orderBy?, pageSize?, pageToken?) -> {channels, nextPageToken}
List customLists
Lists custom lists. The order is defined by the order_by parameter.
displayvideo_custom_lists_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?) -> {customLists, nextPageToken}
List inventorySourceGroups
Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
displayvideo_inventory_source_groups_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {inventorySourceGroups, nextPageToken}
Get advertisers campaigns targetingTypes assignedTargetingOptions
Gets a single targeting option assigned to a campaign.
displayvideo_advertisers_campaigns_targeting_types_assigned_targeting_options_get(advertiserId, assignedTargetingOptionId, campaignId, targetingType) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Get advertisers adAssets
Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
displayvideo_advertisers_ad_assets_get(adAssetId, advertiserId) -> {adAssetId, adAssetType, entityStatus, name, ...}
List combinedAudiences
Lists combined audiences. The order is defined by the order_by parameter.
displayvideo_combined_audiences_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {combinedAudiences, nextPageToken}
Get floodlightGroups floodlightActivities
Gets a Floodlight activity.
displayvideo_floodlight_groups_floodlight_activities_get(floodlightActivityId, floodlightGroupId, partnerId?) -> {advertiserIds, displayName, floodlightActivityId, floodlightGroupId, ...}
List firstPartyAndPartnerAudiences
Lists first party and partner audiences. The order is defined by the order_by parameter.
displayvideo_first_party_and_partner_audiences_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {firstPartyAndPartnerAudiences, nextPageToken}
Create firstPartyAndPartnerAudiences
Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
displayvideo_first_party_and_partner_audiences_create(activeDisplayAudienceSize?, advertiserId?, appId?, audienceSource?, audienceType?, contactInfoList?, description?, displayAudienceSize?, displayDesktopAudienceSize?, displayMobileAppAudienceSize?, displayMobileWebAudienceSize?, displayName?, firstPartyAndPartnerAudienceId?, firstPartyAndPartnerAudienceType?, gmailAudienceSize?, membershipDurationDays?, mobileDeviceIdList?, name?, youtubeAudienceSize?) -> {activeDisplayAudienceSize, appId, audienceSource, audienceType, ...}
Lookupinvoicecurrency advertisers invoices
Retrieves the invoice currency used by an advertiser in a given month.
displayvideo_advertisers_invoices_lookup_invoice_currency(advertiserId, invoiceMonth?) -> {currencyCode}
List advertisers locationLists
Lists location lists based on a given advertiser id.
displayvideo_advertisers_location_lists_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {locationLists, nextPageToken}
List advertisers adGroups targetingTypes assignedTargetingOptions
Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
displayvideo_advertisers_ad_groups_targeting_types_assigned_targeting_options_list(adGroupId, advertiserId, targetingType, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Get advertisers insertionOrders targetingTypes assignedTargetingOptions
Gets a single targeting option assigned to an insertion order.
displayvideo_advertisers_insertion_orders_targeting_types_assigned_targeting_options_get(advertiserId, assignedTargetingOptionId, insertionOrderId, targetingType) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Delete advertisers insertionOrders targetingTypes assignedTargetingOptions
Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
displayvideo_advertisers_insertion_orders_targeting_types_assigned_targeting_options_delete(advertiserId, assignedTargetingOptionId, insertionOrderId, targetingType) -> {}
Generatedefault advertisers lineItems
Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_generate_default(advertiserId, containsEuPoliticalAds?, displayName?, insertionOrderId?, lineItemType?, mobileApp?) -> {advertiserId, bidStrategy, budget, campaignId, ...}
Bulklistassignedtargetingoptions advertisers adGroups
Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
displayvideo_advertisers_ad_groups_bulk_list_assigned_targeting_options(advertiserId, adGroupIds?, filter?, orderBy?, pageSize?, pageToken?) -> {adGroupAssignedTargetingOptions, nextPageToken}
List advertisers creatives
Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
displayvideo_advertisers_creatives_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {creatives, nextPageToken}
List customBiddingAlgorithms rules
Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
displayvideo_custom_bidding_algorithms_rules_list(customBiddingAlgorithmId, advertiserId?, orderBy?, pageSize?, pageToken?, partnerId?) -> {customBiddingRules, nextPageToken}
List guaranteedOrders
Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
displayvideo_guaranteed_orders_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {guaranteedOrders, nextPageToken}
Create guaranteedOrders
Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
displayvideo_guaranteed_orders_create(advertiserId?, defaultAdvertiserId?, defaultCampaignId?, displayName?, exchange?, guaranteedOrderId?, legacyGuaranteedOrderId?, name?, partnerId?, publisherName?, readAccessInherited?, readAdvertiserIds?, readWriteAdvertiserId?, readWritePartnerId?, status?, updateTime?) -> {defaultAdvertiserId, defaultCampaignId, displayName, exchange, ...}
Create advertisers campaigns
Creates a new campaign. Returns the newly created campaign if successful.
displayvideo_advertisers_campaigns_create(advertiserId, advertiserId?, campaignBudgets?, campaignFlight?, campaignGoal?, campaignId?, displayName?, entityStatus?, frequencyCap?, name?, updateTime?) -> {advertiserId, campaignBudgets, campaignFlight, campaignGoal, ...}
Create sdfdownloadtasks
Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty.
displayvideo_sdfdownloadtasks_create(advertiserId?, idFilter?, inventorySourceFilter?, parentEntityFilter?, partnerId?, version?) -> {done, error, metadata, name, ...}
Get advertisers adGroupAds
Gets an ad group ad.
displayvideo_advertisers_ad_group_ads_get(adGroupAdId, advertiserId) -> {adGroupAdId, adGroupId, adPolicy, adUrls, ...}
Editinventorysourcereadwriteaccessors inventorySources
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
displayvideo_inventory_sources_edit_inventory_source_read_write_accessors(inventorySourceId, advertisersUpdate?, assignPartner?, partnerId?) -> {advertisers, partner}
List advertisers channels sites
Lists sites in a channel.
displayvideo_advertisers_channels_sites_list(advertiserId, channelId, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {nextPageToken, sites}
Bulkedit advertisers channels sites
Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
displayvideo_advertisers_channels_sites_bulk_edit(advertiserId, channelId, advertiserId?, createdSites?, deletedSites?, partnerId?) -> {sites}
List advertisers adGroups youtubeAssetTypes youtubeAssetAssociations
Lists the YouTube asset associations linked to the given resource.
displayvideo_advertisers_ad_groups_youtube_asset_types_youtube_asset_associations_list(adGroupId, advertiserId, youtubeAssetType, linkedEntity.lineItemId?, orderBy?, pageSize?, pageToken?) -> {nextPageToken, youtubeAssetAssociations}
Get advertisers insertionOrders
Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
displayvideo_advertisers_insertion_orders_get(advertiserId, insertionOrderId) -> {advertiserId, bidStrategy, budget, campaignId, ...}
List advertisers lineItems youtubeAssetTypes youtubeAssetAssociations
Lists the YouTube asset associations linked to the given resource.
displayvideo_advertisers_line_items_youtube_asset_types_youtube_asset_associations_list(advertiserId, lineItemId, youtubeAssetType, linkedEntity.adGroupId?, orderBy?, pageSize?, pageToken?) -> {nextPageToken, youtubeAssetAssociations}
Get inventorySources
Gets an inventory source.
displayvideo_inventory_sources_get(inventorySourceId, advertiserId?, partnerId?) -> {commitment, creativeConfigs, dealId, deliveryMethod, ...}
Partially update partners channels
Updates a channel. Returns the updated channel if successful.
displayvideo_partners_channels_patch(channelId, partnerId, advertiserId?, advertiserId?, channelId?, displayName?, name?, negativelyTargetedLineItemCount?, partnerId?, positivelyTargetedLineItemCount?, updateMask?) -> {advertiserId, channelId, displayName, name, ...}
Create advertisers targetingTypes assignedTargetingOptions
Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
displayvideo_advertisers_targeting_types_assigned_targeting_options_create(advertiserId, targetingType, ageRangeDetails?, appCategoryDetails?, appDetails?, assignedTargetingOptionId?, assignedTargetingOptionIdAlias?, audienceGroupDetails?, audioContentTypeDetails?, authorizedSellerStatusDetails?, browserDetails?, businessChainDetails?, carrierAndIspDetails?, categoryDetails?, channelDetails?, contentDurationDetails?, contentGenreDetails?, contentInstreamPositionDetails?, contentOutstreamPositionDetails?, contentStreamTypeDetails?, contentThemeExclusionDetails?, dayAndTimeDetails?, deviceMakeModelDetails?, deviceTypeDetails?, digitalContentLabelExclusionDetails?, environmentDetails?, exchangeDetails?, genderDetails?, geoRegionDetails?, householdIncomeDetails?, inheritance?, inventorySourceDetails?, inventorySourceGroupDetails?, keywordDetails?, languageDetails?, name?, nativeContentPositionDetails?, negativeKeywordListDetails?, omidDetails?, onScreenPositionDetails?, operatingSystemDetails?, parentalStatusDetails?, poiDetails?, proximityLocationListDetails?, regionalLocationListDetails?, sensitiveCategoryExclusionDetails?, sessionPositionDetails?, subExchangeDetails?, targetingType?, thirdPartyVerifierDetails?, urlDetails?, userRewardedContentDetails?, videoPlayerSizeDetails?, viewabilityDetails?, youtubeChannelDetails?, youtubeVideoDetails?) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
List advertisers locationLists assignedLocations
Lists locations assigned to a location list.
displayvideo_advertisers_location_lists_assigned_locations_list(advertiserId, locationListId, filter?, orderBy?, pageSize?, pageToken?) -> {assignedLocations, nextPageToken}
List advertisers channels
Lists channels for a partner or advertiser.
displayvideo_advertisers_channels_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {channels, nextPageToken}
Get users
Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
displayvideo_users_get(userId) -> {assignedUserRoles, displayName, email, lastLoginTime, ...}
List floodlightGroups floodlightActivities
Lists Floodlight activities in a Floodlight group.
displayvideo_floodlight_groups_floodlight_activities_list(floodlightGroupId, orderBy?, pageSize?, pageToken?, partnerId?) -> {floodlightActivities, nextPageToken}
List customBiddingAlgorithms
Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
displayvideo_custom_bidding_algorithms_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {customBiddingAlgorithms, nextPageToken}
Create customBiddingAlgorithms
Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
displayvideo_custom_bidding_algorithms_create(advertiserId?, customBiddingAlgorithmId?, customBiddingAlgorithmType?, displayName?, entityStatus?, modelDetails?, name?, partnerId?, sharedAdvertiserIds?, thirdPartyOptimizationPartner?) -> {advertiserId, customBiddingAlgorithmId, customBiddingAlgorithmType, displayName, ...}
Create advertisers
Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
displayvideo_advertisers_create(adServerConfig?, advertiserId?, billingConfig?, containsEuPoliticalAds?, creativeConfig?, dataAccessConfig?, displayName?, entityStatus?, generalConfig?, integrationDetails?, name?, partnerId?, prismaEnabled?, servingConfig?, updateTime?) -> {adServerConfig, advertiserId, billingConfig, containsEuPoliticalAds, ...}
Get customBiddingAlgorithms
Gets a custom bidding algorithm.
displayvideo_custom_bidding_algorithms_get(customBiddingAlgorithmId, advertiserId?, partnerId?) -> {advertiserId, customBiddingAlgorithmId, customBiddingAlgorithmType, displayName, ...}
Get advertisers adGroups
Gets an ad group.
displayvideo_advertisers_ad_groups_get(adGroupId, advertiserId) -> {adGroupFormat, adGroupId, advertiserId, bidStrategy, ...}
List advertisers adGroups
Lists ad groups.
displayvideo_advertisers_ad_groups_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {adGroups, nextPageToken}
Partially update advertisers
Updates an existing advertiser. Returns the updated advertiser if successful.
displayvideo_advertisers_patch(advertiserId, adServerConfig?, advertiserId?, billingConfig?, containsEuPoliticalAds?, creativeConfig?, dataAccessConfig?, displayName?, entityStatus?, generalConfig?, integrationDetails?, name?, partnerId?, prismaEnabled?, servingConfig?, updateMask?, updateTime?) -> {adServerConfig, advertiserId, billingConfig, containsEuPoliticalAds, ...}
Bulkedit inventorySourceGroups assignedInventorySources
Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
displayvideo_inventory_source_groups_assigned_inventory_sources_bulk_edit(inventorySourceGroupId, advertiserId?, createdAssignedInventorySources?, deletedAssignedInventorySources?, partnerId?) -> {assignedInventorySources}
Delete partners targetingTypes assignedTargetingOptions
Deletes an assigned targeting option from a partner.
displayvideo_partners_targeting_types_assigned_targeting_options_delete(assignedTargetingOptionId, partnerId, targetingType) -> {}
Get sdfuploadtasks operations
Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
displayvideo_sdfuploadtasks_operations_get(name) -> {done, error, metadata, name, ...}
Editassignedtargetingoptions partners
Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .
displayvideo_partners_edit_assigned_targeting_options(partnerId, createRequests?, deleteRequests?) -> {createdAssignedTargetingOptions}
Get advertisers lineItems
Gets a line item.
displayvideo_advertisers_line_items_get(advertiserId, lineItemId) -> {advertiserId, bidStrategy, budget, campaignId, ...}
List users
Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
displayvideo_users_list(filter?, orderBy?, pageSize?, pageToken?) -> {nextPageToken, users}
List advertisers invoices
Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.
displayvideo_advertisers_invoices_list(advertiserId, issueMonth?, loiSapinInvoiceType?, pageSize?, pageToken?) -> {invoices, nextPageToken}
Get customLists
Gets a custom list.
displayvideo_custom_lists_get(customListId, advertiserId?) -> {customListId, displayName, name}
List advertisers negativeKeywordLists negativeKeywords
Lists negative keywords in a negative keyword list.
displayvideo_advertisers_negative_keyword_lists_negative_keywords_list(advertiserId, negativeKeywordListId, filter?, orderBy?, pageSize?, pageToken?) -> {negativeKeywords, nextPageToken}
Bulkupdate advertisers lineItems
Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_bulk_update(advertiserId, lineItemIds?, targetLineItem?, updateMask?) -> {errors, failedLineItemIds, skippedLineItemIds, updatedLineItemIds}
Create inventorySources
Creates a new inventory source. Returns the newly created inventory source if successful.
displayvideo_inventory_sources_create(advertiserId?, commitment?, creativeConfigs?, dealId?, deliveryMethod?, displayName?, exchange?, guaranteedOrderId?, inventorySourceId?, inventorySourceProductType?, inventorySourceType?, name?, partnerId?, publisherName?, rateDetails?, readAdvertiserIds?, readPartnerIds?, readWriteAccessors?, status?, timeRange?, updateTime?) -> {commitment, creativeConfigs, dealId, deliveryMethod, ...}
Create advertisers adAssets
Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
displayvideo_advertisers_ad_assets_create(advertiserId, adAsset?) -> {adAssetId, adAssetType, entityStatus, name, ...}
Search targetingTypes targetingOptions
Searches for targeting options of a given type based on the given search terms.
displayvideo_targeting_types_targeting_options_search(targetingType, advertiserId?, businessChainSearchTerms?, geoRegionSearchTerms?, pageSize?, pageToken?, poiSearchTerms?) -> {nextPageToken, targetingOptions}
Get guaranteedOrders
Gets a guaranteed order.
displayvideo_guaranteed_orders_get(guaranteedOrderId, advertiserId?, partnerId?) -> {defaultAdvertiserId, defaultCampaignId, displayName, exchange, ...}
Create advertisers insertionOrders targetingTypes assignedTargetingOptions
Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
displayvideo_advertisers_insertion_orders_targeting_types_assigned_targeting_options_create(advertiserId, insertionOrderId, targetingType, ageRangeDetails?, appCategoryDetails?, appDetails?, assignedTargetingOptionId?, assignedTargetingOptionIdAlias?, audienceGroupDetails?, audioContentTypeDetails?, authorizedSellerStatusDetails?, browserDetails?, businessChainDetails?, carrierAndIspDetails?, categoryDetails?, channelDetails?, contentDurationDetails?, contentGenreDetails?, contentInstreamPositionDetails?, contentOutstreamPositionDetails?, contentStreamTypeDetails?, contentThemeExclusionDetails?, dayAndTimeDetails?, deviceMakeModelDetails?, deviceTypeDetails?, digitalContentLabelExclusionDetails?, environmentDetails?, exchangeDetails?, genderDetails?, geoRegionDetails?, householdIncomeDetails?, inheritance?, inventorySourceDetails?, inventorySourceGroupDetails?, keywordDetails?, languageDetails?, name?, nativeContentPositionDetails?, negativeKeywordListDetails?, omidDetails?, onScreenPositionDetails?, operatingSystemDetails?, parentalStatusDetails?, poiDetails?, proximityLocationListDetails?, regionalLocationListDetails?, sensitiveCategoryExclusionDetails?, sessionPositionDetails?, subExchangeDetails?, targetingType?, thirdPartyVerifierDetails?, urlDetails?, userRewardedContentDetails?, videoPlayerSizeDetails?, viewabilityDetails?, youtubeChannelDetails?, youtubeVideoDetails?) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Partially update guaranteedOrders
Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
displayvideo_guaranteed_orders_patch(guaranteedOrderId, advertiserId?, defaultAdvertiserId?, defaultCampaignId?, displayName?, exchange?, guaranteedOrderId?, legacyGuaranteedOrderId?, name?, partnerId?, publisherName?, readAccessInherited?, readAdvertiserIds?, readWriteAdvertiserId?, readWritePartnerId?, status?, updateMask?, updateTime?) -> {defaultAdvertiserId, defaultCampaignId, displayName, exchange, ...}
List targetingTypes targetingOptions
Lists targeting options of a given type.
displayvideo_targeting_types_targeting_options_list(targetingType, advertiserId?, filter?, orderBy?, pageSize?, pageToken?) -> {nextPageToken, targetingOptions}
List advertisers lineItems
Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
displayvideo_advertisers_line_items_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {lineItems, nextPageToken}
Get advertisers lineItems targetingTypes assignedTargetingOptions
Gets a single targeting option assigned to a line item.
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_get(advertiserId, assignedTargetingOptionId, lineItemId, targetingType) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Partially update advertisers creatives
Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
displayvideo_advertisers_creatives_patch(advertiserId, creativeId, additionalDimensions?, advertiserId?, appendedTag?, assets?, cmPlacementId?, cmTrackingAd?, companionCreativeIds?, counterEvents?, createTime?, creativeAttributes?, creativeId?, creativeType?, dimensions?, displayName?, dynamic?, entityStatus?, exitEvents?, expandOnHover?, expandingDirection?, hostingSource?, html5Video?, iasCampaignMonitoring?, integrationCode?, jsTrackerUrl?, lineItemIds?, mediaDuration?, mp3Audio?, name?, notes?, obaIcon?, oggAudio?, progressOffset?, requireHtml5?, requireMraid?, requirePingForAttribution?, reviewStatus?, skipOffset?, skippable?, thirdPartyTag?, thirdPartyUrls?, timerEvents?, trackerUrls?, transcodes?, universalAdId?, updateMask?, updateTime?, vastTagUrl?, vpaid?) -> {additionalDimensions, trackerUrls, transcodes, expandOnHover, ...}
Get advertisers creatives
Gets a creative.
displayvideo_advertisers_creatives_get(advertiserId, creativeId) -> {additionalDimensions, trackerUrls, transcodes, expandOnHover, ...}
Listassignedtargetingoptions advertisers
Lists assigned targeting options of an advertiser across targeting types.
displayvideo_advertisers_list_assigned_targeting_options(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Get partners targetingTypes assignedTargetingOptions
Gets a single targeting option assigned to a partner.
displayvideo_partners_targeting_types_assigned_targeting_options_get(assignedTargetingOptionId, partnerId, targetingType) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Get targetingTypes targetingOptions
Gets a single targeting option.
displayvideo_targeting_types_targeting_options_get(targetingOptionId, targetingType, advertiserId?) -> {digitalContentLabelDetails, operatingSystemDetails, ageRangeDetails, genderDetails, ...}
Partially update inventorySources
Updates an existing inventory source. Returns the updated inventory source if successful.
displayvideo_inventory_sources_patch(inventorySourceId, advertiserId?, commitment?, creativeConfigs?, dealId?, deliveryMethod?, displayName?, exchange?, guaranteedOrderId?, inventorySourceId?, inventorySourceProductType?, inventorySourceType?, name?, partnerId?, publisherName?, rateDetails?, readAdvertiserIds?, readPartnerIds?, readWriteAccessors?, status?, timeRange?, updateMask?, updateTime?) -> {commitment, creativeConfigs, dealId, deliveryMethod, ...}
Editassignedtargetingoptions advertisers
Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
displayvideo_advertisers_edit_assigned_targeting_options(advertiserId, createRequests?, deleteRequests?) -> {createdAssignedTargetingOptions}
Editcustomermatchmembers firstPartyAndPartnerAudiences
Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
displayvideo_first_party_and_partner_audiences_edit_customer_match_members(firstPartyAndPartnerAudienceId, addedContactInfoList?, addedMobileDeviceIdList?, advertiserId?, removedContactInfoList?, removedMobileDeviceIdList?) -> {firstPartyAndPartnerAudienceId}
Listassignedtargetingoptions advertisers insertionOrders
Lists assigned targeting options of an insertion order across targeting types.
displayvideo_advertisers_insertion_orders_list_assigned_targeting_options(advertiserId, insertionOrderId, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Create advertisers lineItems targetingTypes assignedTargetingOptions
Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_create(advertiserId, lineItemId, targetingType, ageRangeDetails?, appCategoryDetails?, appDetails?, assignedTargetingOptionId?, assignedTargetingOptionIdAlias?, audienceGroupDetails?, audioContentTypeDetails?, authorizedSellerStatusDetails?, browserDetails?, businessChainDetails?, carrierAndIspDetails?, categoryDetails?, channelDetails?, contentDurationDetails?, contentGenreDetails?, contentInstreamPositionDetails?, contentOutstreamPositionDetails?, contentStreamTypeDetails?, contentThemeExclusionDetails?, dayAndTimeDetails?, deviceMakeModelDetails?, deviceTypeDetails?, digitalContentLabelExclusionDetails?, environmentDetails?, exchangeDetails?, genderDetails?, geoRegionDetails?, householdIncomeDetails?, inheritance?, inventorySourceDetails?, inventorySourceGroupDetails?, keywordDetails?, languageDetails?, name?, nativeContentPositionDetails?, negativeKeywordListDetails?, omidDetails?, onScreenPositionDetails?, operatingSystemDetails?, parentalStatusDetails?, poiDetails?, proximityLocationListDetails?, regionalLocationListDetails?, sensitiveCategoryExclusionDetails?, sessionPositionDetails?, subExchangeDetails?, targetingType?, thirdPartyVerifierDetails?, urlDetails?, userRewardedContentDetails?, videoPlayerSizeDetails?, viewabilityDetails?, youtubeChannelDetails?, youtubeVideoDetails?) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
List advertisers lineItems targetingTypes assignedTargetingOptions
Lists the targeting options assigned to a line item.
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_list(advertiserId, lineItemId, targetingType, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Create advertisers adGroups youtubeAssetTypes youtubeAssetAssociations
Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
displayvideo_advertisers_ad_groups_youtube_asset_types_youtube_asset_associations_create(adGroupId, advertiserId, youtubeAssetType, linkedEntity.lineItemId?, linkedYoutubeAsset?, name?, youtubeAssetType?) -> {linkedYoutubeAsset, name, youtubeAssetType}
List advertisers insertionOrders
Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
displayvideo_advertisers_insertion_orders_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {insertionOrders, nextPageToken}
Delete advertisers
Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
displayvideo_advertisers_delete(advertiserId) -> {}
Get customBiddingAlgorithms rules
Retrieves a rules resource.
displayvideo_custom_bidding_algorithms_rules_get(customBiddingAlgorithmId, customBiddingAlgorithmRulesId, advertiserId?, partnerId?) -> {active, createTime, customBiddingAlgorithmId, customBiddingAlgorithmRulesId, ...}
Partially update advertisers lineItems
Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
displayvideo_advertisers_line_items_patch(advertiserId, lineItemId, advertiserId?, bidStrategy?, budget?, campaignId?, containsEuPoliticalAds?, conversionCounting?, creativeIds?, displayName?, entityStatus?, excludeNewExchanges?, flight?, frequencyCap?, insertionOrderId?, integrationDetails?, lineItemId?, lineItemType?, mobileApp?, name?, pacing?, partnerCosts?, partnerRevenueModel?, reservationType?, targetingExpansion?, updateMask?, updateTime?, warningMessages?, youtubeAndPartnersSettings?) -> {advertiserId, bidStrategy, budget, campaignId, ...}
List advertisers adGroupAds
Lists ad group ads.
displayvideo_advertisers_ad_group_ads_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {adGroupAds, nextPageToken}
Get combinedAudiences
Gets a combined audience.
displayvideo_combined_audiences_get(combinedAudienceId, advertiserId?, partnerId?) -> {combinedAudienceId, displayName, name}
Get advertisers adGroups targetingTypes assignedTargetingOptions
Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
displayvideo_advertisers_ad_groups_targeting_types_assigned_targeting_options_get(adGroupId, advertiserId, assignedTargetingOptionId, targetingType) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Create customBiddingAlgorithms scripts
Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.
displayvideo_custom_bidding_algorithms_scripts_create(customBiddingAlgorithmId, active?, advertiserId?, createTime?, customBiddingAlgorithmId?, customBiddingScriptId?, errors?, name?, partnerId?, script?, state?) -> {active, createTime, customBiddingAlgorithmId, customBiddingScriptId, ...}
List advertisers adAssets
Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
displayvideo_advertisers_ad_assets_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {adAssets, nextPageToken}
Duplicate advertisers lineItems
Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
displayvideo_advertisers_line_items_duplicate(advertiserId, lineItemId, containsEuPoliticalAds?, targetDisplayName?) -> {duplicateLineItemId}
Delete advertisers negativeKeywordLists
Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
displayvideo_advertisers_negative_keyword_lists_delete(advertiserId, negativeKeywordListId) -> {}
Upload advertisers adAssets
Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
displayvideo_advertisers_ad_assets_upload(advertiserId, adAssetType?, filename?) -> {adAsset}
Create advertisers lineItems youtubeAssetTypes youtubeAssetAssociations
Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
displayvideo_advertisers_line_items_youtube_asset_types_youtube_asset_associations_create(advertiserId, lineItemId, youtubeAssetType, linkedEntity.adGroupId?, linkedYoutubeAsset?, name?, youtubeAssetType?) -> {linkedYoutubeAsset, name, youtubeAssetType}
Replace advertisers channels sites
Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
displayvideo_advertisers_channels_sites_replace(advertiserId, channelId, advertiserId?, newSites?, partnerId?) -> {sites}
Delete advertisers lineItems targetingTypes assignedTargetingOptions
Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_targeting_types_assigned_targeting_options_delete(advertiserId, assignedTargetingOptionId, lineItemId, targetingType) -> {}
List advertisers targetingTypes assignedTargetingOptions
Lists the targeting options assigned to an advertiser.
displayvideo_advertisers_targeting_types_assigned_targeting_options_list(advertiserId, targetingType, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Editguaranteedorderreadaccessors guaranteedOrders
Edits read advertisers of a guaranteed order.
displayvideo_guaranteed_orders_edit_guaranteed_order_read_accessors(guaranteedOrderId, addedAdvertisers?, partnerId?, readAccessInherited?, removedAdvertisers?) -> {readAccessInherited, readAdvertiserIds}
Get advertisers negativeKeywordLists
Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
displayvideo_advertisers_negative_keyword_lists_get(advertiserId, negativeKeywordListId) -> {advertiserId, displayName, name, negativeKeywordListId, ...}
Create advertisers channels
Creates a new channel. Returns the newly created channel if successful.
displayvideo_advertisers_channels_create(advertiserId, advertiserId?, channelId?, displayName?, name?, negativelyTargetedLineItemCount?, partnerId?, partnerId?, positivelyTargetedLineItemCount?) -> {advertiserId, channelId, displayName, name, ...}
List customBiddingAlgorithms scripts
Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
displayvideo_custom_bidding_algorithms_scripts_list(customBiddingAlgorithmId, advertiserId?, orderBy?, pageSize?, pageToken?, partnerId?) -> {customBiddingScripts, nextPageToken}
Partially update advertisers insertionOrders
Updates an existing insertion order. Returns the updated insertion order if successful.
displayvideo_advertisers_insertion_orders_patch(advertiserId, insertionOrderId, advertiserId?, bidStrategy?, budget?, campaignId?, displayName?, entityStatus?, frequencyCap?, insertionOrderId?, insertionOrderType?, integrationDetails?, kpi?, name?, optimizationObjective?, pacing?, partnerCosts?, reservationType?, updateMask?, updateTime?) -> {advertiserId, bidStrategy, budget, campaignId, ...}
Download media
Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.
displayvideo_media_download(resourceName) -> {resourceName}
Get advertisers targetingTypes assignedTargetingOptions
Gets a single targeting option assigned to an advertiser.
displayvideo_advertisers_targeting_types_assigned_targeting_options_get(advertiserId, assignedTargetingOptionId, targetingType) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Bulkedit advertisers locationLists assignedLocations
Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.
displayvideo_advertisers_location_lists_assigned_locations_bulk_edit(advertiserId, locationListId, createdAssignedLocations?, deletedAssignedLocations?) -> {assignedLocations}
List advertisers campaigns
Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
displayvideo_advertisers_campaigns_list(advertiserId, filter?, orderBy?, pageSize?, pageToken?) -> {campaigns, nextPageToken}
Get advertisers campaigns
Gets a campaign.
displayvideo_advertisers_campaigns_get(advertiserId, campaignId) -> {advertiserId, campaignBudgets, campaignFlight, campaignGoal, ...}
Create inventorySourceGroups
Creates a new inventory source group. Returns the newly created inventory source group if successful.
displayvideo_inventory_source_groups_create(advertiserId?, displayName?, inventorySourceGroupId?, name?, partnerId?) -> {displayName, inventorySourceGroupId, name}
Delete advertisers adGroups youtubeAssetTypes youtubeAssetAssociations
Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
displayvideo_advertisers_ad_groups_youtube_asset_types_youtube_asset_associations_delete(adGroupId, advertiserId, youtubeAssetAssociationId, youtubeAssetType, linkedEntity.lineItemId?) -> {}
Bulkeditassigneduserroles users
Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
displayvideo_users_bulk_edit_assigned_user_roles(userId, createdAssignedUserRoles?, deletedAssignedUserRoles?) -> {createdAssignedUserRoles}
Delete advertisers insertionOrders
Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
displayvideo_advertisers_insertion_orders_delete(advertiserId, insertionOrderId) -> {}
Audit advertisers
Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
displayvideo_advertisers_audit(advertiserId, readMask?) -> {adGroupCriteriaCount, campaignCriteriaCount, channelsCount, negativeKeywordListsCount, ...}
Create advertisers creatives
Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
displayvideo_advertisers_creatives_create(advertiserId, additionalDimensions?, advertiserId?, appendedTag?, assets?, cmPlacementId?, cmTrackingAd?, companionCreativeIds?, counterEvents?, createTime?, creativeAttributes?, creativeId?, creativeType?, dimensions?, displayName?, dynamic?, entityStatus?, exitEvents?, expandOnHover?, expandingDirection?, hostingSource?, html5Video?, iasCampaignMonitoring?, integrationCode?, jsTrackerUrl?, lineItemIds?, mediaDuration?, mp3Audio?, name?, notes?, obaIcon?, oggAudio?, progressOffset?, requireHtml5?, requireMraid?, requirePingForAttribution?, reviewStatus?, skipOffset?, skippable?, thirdPartyTag?, thirdPartyUrls?, timerEvents?, trackerUrls?, transcodes?, universalAdId?, updateTime?, vastTagUrl?, vpaid?) -> {additionalDimensions, trackerUrls, transcodes, expandOnHover, ...}
Get advertisers
Gets an advertiser.
displayvideo_advertisers_get(advertiserId) -> {adServerConfig, advertiserId, billingConfig, containsEuPoliticalAds, ...}
Create advertisers negativeKeywordLists negativeKeywords
Creates a negative keyword in a negative keyword list.
displayvideo_advertisers_negative_keyword_lists_negative_keywords_create(advertiserId, negativeKeywordListId, keywordValue?, name?) -> {keywordValue, name}
Partially update customBiddingAlgorithms
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.
displayvideo_custom_bidding_algorithms_patch(customBiddingAlgorithmId, advertiserId?, customBiddingAlgorithmId?, customBiddingAlgorithmType?, displayName?, entityStatus?, modelDetails?, name?, partnerId?, sharedAdvertiserIds?, thirdPartyOptimizationPartner?, updateMask?) -> {advertiserId, customBiddingAlgorithmId, customBiddingAlgorithmType, displayName, ...}
Get advertisers channels
Gets a channel for a partner or advertiser.
displayvideo_advertisers_channels_get(advertiserId, channelId, partnerId?) -> {advertiserId, channelId, displayName, name, ...}
Get inventorySourceGroups
Gets an inventory source group.
displayvideo_inventory_source_groups_get(inventorySourceGroupId, advertiserId?, partnerId?) -> {displayName, inventorySourceGroupId, name}
Partially update advertisers negativeKeywordLists
Updates a negative keyword list. Returns the updated negative keyword list if successful.
displayvideo_advertisers_negative_keyword_lists_patch(advertiserId, negativeKeywordListId, advertiserId?, displayName?, name?, negativeKeywordListId?, targetedLineItemCount?, updateMask?) -> {advertiserId, displayName, name, negativeKeywordListId, ...}
List advertisers campaigns targetingTypes assignedTargetingOptions
Lists the targeting options assigned to a campaign for a specified targeting type.
displayvideo_advertisers_campaigns_targeting_types_assigned_targeting_options_list(advertiserId, campaignId, targetingType, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Create partners targetingTypes assignedTargetingOptions
Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
displayvideo_partners_targeting_types_assigned_targeting_options_create(partnerId, targetingType, ageRangeDetails?, appCategoryDetails?, appDetails?, assignedTargetingOptionId?, assignedTargetingOptionIdAlias?, audienceGroupDetails?, audioContentTypeDetails?, authorizedSellerStatusDetails?, browserDetails?, businessChainDetails?, carrierAndIspDetails?, categoryDetails?, channelDetails?, contentDurationDetails?, contentGenreDetails?, contentInstreamPositionDetails?, contentOutstreamPositionDetails?, contentStreamTypeDetails?, contentThemeExclusionDetails?, dayAndTimeDetails?, deviceMakeModelDetails?, deviceTypeDetails?, digitalContentLabelExclusionDetails?, environmentDetails?, exchangeDetails?, genderDetails?, geoRegionDetails?, householdIncomeDetails?, inheritance?, inventorySourceDetails?, inventorySourceGroupDetails?, keywordDetails?, languageDetails?, name?, nativeContentPositionDetails?, negativeKeywordListDetails?, omidDetails?, onScreenPositionDetails?, operatingSystemDetails?, parentalStatusDetails?, poiDetails?, proximityLocationListDetails?, regionalLocationListDetails?, sensitiveCategoryExclusionDetails?, sessionPositionDetails?, subExchangeDetails?, targetingType?, thirdPartyVerifierDetails?, urlDetails?, userRewardedContentDetails?, videoPlayerSizeDetails?, viewabilityDetails?, youtubeChannelDetails?, youtubeVideoDetails?) -> {operatingSystemDetails, ageRangeDetails, genderDetails, omidDetails, ...}
Bulkcreate advertisers adAssets
Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
displayvideo_advertisers_ad_assets_bulk_create(advertiserId, adAssets?) -> {adAssets}
Partially update floodlightGroups
Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
displayvideo_floodlight_groups_patch(floodlightGroupId, activeViewConfig?, customVariables?, displayName?, floodlightGroupId?, lookbackWindow?, name?, partnerId?, updateMask?, webTagType?) -> {activeViewConfig, customVariables, displayName, floodlightGroupId, ...}
Delete partners channels sites
Deletes a site from a channel.
displayvideo_partners_channels_sites_delete(channelId, partnerId, urlOrAppId, advertiserId?) -> {}
Delete advertisers campaigns
Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
displayvideo_advertisers_campaigns_delete(advertiserId, campaignId) -> {}
List advertisers insertionOrders targetingTypes assignedTargetingOptions
Lists the targeting options assigned to an insertion order.
displayvideo_advertisers_insertion_orders_targeting_types_assigned_targeting_options_list(advertiserId, insertionOrderId, targetingType, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Get partners
Gets a partner.
displayvideo_partners_get(partnerId) -> {adServerConfig, billingConfig, dataAccessConfig, displayName, ...}
Create partners channels sites
Creates a site in a channel.
displayvideo_partners_channels_sites_create(channelId, partnerId, advertiserId?, name?, urlOrAppId?) -> {name, urlOrAppId}
Listassignedtargetingoptions advertisers campaigns
Lists assigned targeting options of a campaign across targeting types.
displayvideo_advertisers_campaigns_list_assigned_targeting_options(advertiserId, campaignId, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Get customBiddingAlgorithms scripts
Gets a custom bidding script.
displayvideo_custom_bidding_algorithms_scripts_get(customBiddingAlgorithmId, customBiddingScriptId, advertiserId?, partnerId?) -> {active, createTime, customBiddingAlgorithmId, customBiddingScriptId, ...}
Get floodlightGroups
Gets a Floodlight group.
displayvideo_floodlight_groups_get(floodlightGroupId, partnerId?) -> {activeViewConfig, customVariables, displayName, floodlightGroupId, ...}
Create advertisers insertionOrders
Creates a new insertion order. Returns the newly created insertion order if successful.
displayvideo_advertisers_insertion_orders_create(advertiserId, advertiserId?, bidStrategy?, budget?, campaignId?, displayName?, entityStatus?, frequencyCap?, insertionOrderId?, insertionOrderType?, integrationDetails?, kpi?, name?, optimizationObjective?, pacing?, partnerCosts?, reservationType?, updateTime?) -> {advertiserId, bidStrategy, budget, campaignId, ...}
List inventorySources
Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
displayvideo_inventory_sources_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {inventorySources, nextPageToken}
Bulklistassignedtargetingoptions advertisers lineItems
Lists assigned targeting options for multiple line items across targeting types.
displayvideo_advertisers_line_items_bulk_list_assigned_targeting_options(advertiserId, filter?, lineItemIds?, orderBy?, pageSize?, pageToken?) -> {lineItemAssignedTargetingOptions, nextPageToken}
Bulkedit advertisers negativeKeywordLists negativeKeywords
Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.
displayvideo_advertisers_negative_keyword_lists_negative_keywords_bulk_edit(advertiserId, negativeKeywordListId, createdNegativeKeywords?, deletedNegativeKeywords?) -> {negativeKeywords}
Delete advertisers locationLists assignedLocations
Deletes the assignment between a location and a location list.
displayvideo_advertisers_location_lists_assigned_locations_delete(advertiserId, assignedLocationId, locationListId) -> {}
Delete advertisers channels sites
Deletes a site from a channel.
displayvideo_advertisers_channels_sites_delete(advertiserId, channelId, urlOrAppId, partnerId?) -> {}
Partially update users
Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
displayvideo_users_patch(userId, assignedUserRoles?, displayName?, email?, lastLoginTime?, name?, updateMask?, userId?) -> {assignedUserRoles, displayName, email, lastLoginTime, ...}
Create customBiddingAlgorithms rules
Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error.
displayvideo_custom_bidding_algorithms_rules_create(customBiddingAlgorithmId, active?, advertiserId?, createTime?, customBiddingAlgorithmId?, customBiddingAlgorithmRulesId?, error?, name?, partnerId?, rules?, state?) -> {active, createTime, customBiddingAlgorithmId, customBiddingAlgorithmRulesId, ...}
List googleAudiences
Lists Google audiences. The order is defined by the order_by parameter.
displayvideo_google_audiences_list(advertiserId?, filter?, orderBy?, pageSize?, pageToken?, partnerId?) -> {googleAudiences, nextPageToken}
Delete inventorySourceGroups
Deletes an inventory source group.
displayvideo_inventory_source_groups_delete(inventorySourceGroupId, advertiserId?, partnerId?) -> {}
Create users
Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
displayvideo_users_create(assignedUserRoles?, displayName?, email?, lastLoginTime?, name?, userId?) -> {assignedUserRoles, displayName, email, lastLoginTime, ...}
Delete users
Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
displayvideo_users_delete(userId) -> {}
Delete advertisers creatives
Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
displayvideo_advertisers_creatives_delete(advertiserId, creativeId) -> {}
Create advertisers lineItems
Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_create(advertiserId, advertiserId?, bidStrategy?, budget?, campaignId?, containsEuPoliticalAds?, conversionCounting?, creativeIds?, displayName?, entityStatus?, excludeNewExchanges?, flight?, frequencyCap?, insertionOrderId?, integrationDetails?, lineItemId?, lineItemType?, mobileApp?, name?, pacing?, partnerCosts?, partnerRevenueModel?, reservationType?, targetingExpansion?, updateTime?, warningMessages?, youtubeAndPartnersSettings?) -> {advertiserId, bidStrategy, budget, campaignId, ...}
Create advertisers channels sites
Creates a site in a channel.
displayvideo_advertisers_channels_sites_create(advertiserId, channelId, name?, partnerId?, urlOrAppId?) -> {name, urlOrAppId}
List partners channels sites
Lists sites in a channel.
displayvideo_partners_channels_sites_list(channelId, partnerId, advertiserId?, filter?, orderBy?, pageSize?, pageToken?) -> {nextPageToken, sites}
Delete advertisers lineItems youtubeAssetTypes youtubeAssetAssociations
Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
displayvideo_advertisers_line_items_youtube_asset_types_youtube_asset_associations_delete(advertiserId, lineItemId, youtubeAssetAssociationId, youtubeAssetType, linkedEntity.adGroupId?) -> {}
Get firstPartyAndPartnerAudiences
Gets a first party or partner audience.
displayvideo_first_party_and_partner_audiences_get(firstPartyAndPartnerAudienceId, advertiserId?, partnerId?) -> {activeDisplayAudienceSize, appId, audienceSource, audienceType, ...}
Create partners channels
Creates a new channel. Returns the newly created channel if successful.
displayvideo_partners_channels_create(partnerId, advertiserId?, advertiserId?, channelId?, displayName?, name?, negativelyTargetedLineItemCount?, partnerId?, positivelyTargetedLineItemCount?) -> {advertiserId, channelId, displayName, name, ...}
Create advertisers negativeKeywordLists
Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
displayvideo_advertisers_negative_keyword_lists_create(advertiserId, advertiserId?, displayName?, name?, negativeKeywordListId?, targetedLineItemCount?) -> {advertiserId, displayName, name, negativeKeywordListId, ...}
Delete advertisers negativeKeywordLists negativeKeywords
Deletes a negative keyword from a negative keyword list.
displayvideo_advertisers_negative_keyword_lists_negative_keywords_delete(advertiserId, keywordValue, negativeKeywordListId) -> {}
Upload media
Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.
displayvideo_media_upload(resourceName, resourceName?) -> {resourceName}
Uploadrules customBiddingAlgorithms
Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.
displayvideo_custom_bidding_algorithms_upload_rules(customBiddingAlgorithmId, advertiserId?, partnerId?) -> {resourceName}
Partially update advertisers locationLists
Updates a location list. Returns the updated location list if successful.
displayvideo_advertisers_location_lists_patch(advertiserId, locationListId, advertiserId?, displayName?, locationListId?, locationType?, name?, updateMask?) -> {advertiserId, displayName, locationListId, locationType, ...}
Partially update advertisers channels
Updates a channel. Returns the updated channel if successful.
displayvideo_advertisers_channels_patch(advertiserId, channelId, advertiserId?, channelId?, displayName?, name?, negativelyTargetedLineItemCount?, partnerId?, partnerId?, positivelyTargetedLineItemCount?, updateMask?) -> {advertiserId, channelId, displayName, name, ...}
Partially update firstPartyAndPartnerAudiences
Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
displayvideo_first_party_and_partner_audiences_patch(firstPartyAndPartnerAudienceId, activeDisplayAudienceSize?, advertiserId?, appId?, audienceSource?, audienceType?, contactInfoList?, description?, displayAudienceSize?, displayDesktopAudienceSize?, displayMobileAppAudienceSize?, displayMobileWebAudienceSize?, displayName?, firstPartyAndPartnerAudienceId?, firstPartyAndPartnerAudienceType?, gmailAudienceSize?, membershipDurationDays?, mobileDeviceIdList?, name?, updateMask?, youtubeAudienceSize?) -> {activeDisplayAudienceSize, appId, audienceSource, audienceType, ...}
Bulkedit partners channels sites
Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
displayvideo_partners_channels_sites_bulk_edit(channelId, partnerId, advertiserId?, createdSites?, deletedSites?, partnerId?) -> {sites}
Create advertisers locationLists assignedLocations
Creates an assignment between a location and a location list.
displayvideo_advertisers_location_lists_assigned_locations_create(advertiserId, locationListId, assignedLocationId?, name?, targetingOptionId?) -> {assignedLocationId, name, targetingOptionId}
Create inventorySourceGroups assignedInventorySources
Creates an assignment between an inventory source and an inventory source group.
displayvideo_inventory_source_groups_assigned_inventory_sources_create(inventorySourceGroupId, advertiserId?, assignedInventorySourceId?, inventorySourceId?, name?, partnerId?) -> {assignedInventorySourceId, inventorySourceId, name}
Get googleAudiences
Gets a Google audience.
displayvideo_google_audiences_get(googleAudienceId, advertiserId?, partnerId?) -> {displayName, googleAudienceId, googleAudienceType, name}
Create advertisers locationLists
Creates a new location list. Returns the newly created location list if successful.
displayvideo_advertisers_location_lists_create(advertiserId, advertiserId?, displayName?, locationListId?, locationType?, name?) -> {advertiserId, displayName, locationListId, locationType, ...}
Delete advertisers lineItems
Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_delete(advertiserId, lineItemId) -> {}
Bulkeditassignedtargetingoptions advertisers lineItems
Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
displayvideo_advertisers_line_items_bulk_edit_assigned_targeting_options(advertiserId, createRequests?, deleteRequests?, lineItemIds?) -> {errors, failedLineItemIds, updatedLineItemIds}
Partially update advertisers campaigns
Updates an existing campaign. Returns the updated campaign if successful.
displayvideo_advertisers_campaigns_patch(advertiserId, campaignId, advertiserId?, campaignBudgets?, campaignFlight?, campaignGoal?, campaignId?, displayName?, entityStatus?, frequencyCap?, name?, updateMask?, updateTime?) -> {advertiserId, campaignBudgets, campaignFlight, campaignGoal, ...}
Replace advertisers negativeKeywordLists negativeKeywords
Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
displayvideo_advertisers_negative_keyword_lists_negative_keywords_replace(advertiserId, negativeKeywordListId, newNegativeKeywords?) -> {negativeKeywords}
Delete inventorySourceGroups assignedInventorySources
Deletes the assignment between an inventory source and an inventory source group.
displayvideo_inventory_source_groups_assigned_inventory_sources_delete(assignedInventorySourceId, inventorySourceGroupId, advertiserId?, partnerId?) -> {}
Partially update inventorySourceGroups
Updates an inventory source group. Returns the updated inventory source group if successful.
displayvideo_inventory_source_groups_patch(inventorySourceGroupId, advertiserId?, displayName?, inventorySourceGroupId?, name?, partnerId?, updateMask?) -> {displayName, inventorySourceGroupId, name}
Get partners channels
Gets a channel for a partner or advertiser.
displayvideo_partners_channels_get(channelId, partnerId, advertiserId?) -> {advertiserId, channelId, displayName, name, ...}
Replace partners channels sites
Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
displayvideo_partners_channels_sites_replace(channelId, partnerId, advertiserId?, newSites?, partnerId?) -> {sites}
List partners targetingTypes assignedTargetingOptions
Lists the targeting options assigned to a partner.
displayvideo_partners_targeting_types_assigned_targeting_options_list(partnerId, targetingType, filter?, orderBy?, pageSize?, pageToken?) -> {assignedTargetingOptions, nextPageToken}
Get advertisers locationLists
Gets a location list.
displayvideo_advertisers_location_lists_get(advertiserId, locationListId) -> {advertiserId, displayName, locationListId, locationType, ...}
Links
No external links available.
Authentication
-
API Key
-
Oauth2_authorization_code (Primary)