Display & Video 360 API

    • Display & Video 360 API v1 is no longer supported.

    • The Display & Video 360 API allows for automation of complex workflows, such as creating insertion orders and setting line item targeting.

    • Client libraries are recommended for calling the displayvideo.googleapis.com service, though custom libraries can also be used.

    • The service endpoint for the Display & Video 360 API v1 is https://displayvideo.googleapis.com.

    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.

    Service: displayvideo.googleapis.com

    To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

    Discovery document

    A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

    Service endpoint

    A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

    • https://displayvideo.googleapis.com

    REST Resource: v1.advertisers

    Methods
    audit GET /v1/advertisers/{advertiserId}:audit
    Audits an advertiser.
    bulkEditAdvertiserAssignedTargetingOptions POST /v1/advertisers/{advertiserId}:bulkEditAdvertiserAssignedTargetingOptions
    Bulk edits targeting options under a single advertiser.
    bulkListAdvertiserAssignedTargetingOptions GET /v1/advertisers/{advertiserId}:bulkListAdvertiserAssignedTargetingOptions
    Lists assigned targeting options of an advertiser across targeting types.
    create POST /v1/advertisers
    Creates a new advertiser.
    delete DELETE /v1/advertisers/{advertiserId}
    Deletes an advertiser.
    get GET /v1/advertisers/{advertiserId}
    Gets an advertiser.
    list GET /v1/advertisers
    Lists advertisers that are accessible to the current user.
    patch PATCH /v1/advertisers/{advertiser.advertiserId}
    Updates an existing advertiser.

    REST Resource: v1.advertisers.assets

    Methods
    upload POST /v1/advertisers/{advertiserId}/assets
    POST /upload/v1/advertisers/{advertiserId}/assets
    Uploads an asset.

    REST Resource: v1.advertisers.campaigns

    Methods
    bulkListCampaignAssignedTargetingOptions GET /v1/advertisers/{advertiserId}/campaigns/{campaignId}:bulkListCampaignAssignedTargetingOptions
    Lists assigned targeting options of a campaign across targeting types.
    create POST /v1/advertisers/{campaign.advertiserId}/campaigns
    Creates a new campaign.
    delete DELETE /v1/advertisers/{advertiserId}/campaigns/{campaignId}
    Permanently deletes a campaign.
    get GET /v1/advertisers/{advertiserId}/campaigns/{campaignId}
    Gets a campaign.
    list GET /v1/advertisers/{advertiserId}/campaigns
    Lists campaigns in an advertiser.
    patch PATCH /v1/advertisers/{campaign.advertiserId}/campaigns/{campaign.campaignId}
    Updates an existing campaign.

    REST Resource: v1.advertisers.campaigns.targetingTypes.assignedTargetingOptions

    Methods
    get GET /v1/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Gets a single targeting option assigned to a campaign.
    list GET /v1/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Lists the targeting options assigned to a campaign for a specified targeting type.

    REST Resource: v1.advertisers.channels

    Methods
    create POST /v1/advertisers/{advertiserId}/channels
    Creates a new channel.
    get GET /v1/advertisers/{advertiserId}/channels/{channelId}
    Gets a channel for a partner or advertiser.
    list GET /v1/advertisers/{advertiserId}/channels
    Lists channels for a partner or advertiser.
    patch PATCH /v1/advertisers/{advertiserId}/channels/{channel.channelId}
    Updates a channel.

    REST Resource: v1.advertisers.channels.sites

    Methods
    bulkEdit POST /v1/advertisers/{advertiserId}/channels/{channelId}/sites:bulkEdit
    Bulk edits sites under a single channel.
    create POST /v1/advertisers/{advertiserId}/channels/{channelId}/sites
    Creates a site in a channel.
    delete DELETE /v1/advertisers/{advertiserId}/channels/{channelId}/sites/{urlOrAppId}
    Deletes a site from a channel.
    list GET /v1/advertisers/{advertiserId}/channels/{channelId}/sites
    Lists sites in a channel.
    replace POST /v1/advertisers/{advertiserId}/channels/{channelId}/sites:replace
    Replaces all of the sites under a single channel.

    REST Resource: v1.advertisers.creatives

    Methods
    create POST /v1/advertisers/{creative.advertiserId}/creatives
    Creates a new creative.
    delete DELETE /v1/advertisers/{advertiserId}/creatives/{creativeId}
    Deletes a creative.
    get GET /v1/advertisers/{advertiserId}/creatives/{creativeId}
    Gets a creative.
    list GET /v1/advertisers/{advertiserId}/creatives
    Lists creatives in an advertiser.
    patch PATCH /v1/advertisers/{creative.advertiserId}/creatives/{creative.creativeId}
    Updates an existing creative.

    REST Resource: v1.advertisers.insertionOrders

    Methods
    bulkListInsertionOrderAssignedTargetingOptions GET /v1/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}:bulkListInsertionOrderAssignedTargetingOptions
    Lists assigned targeting options of an insertion order across targeting types.
    create POST /v1/advertisers/{insertionOrder.advertiserId}/insertionOrders
    Creates a new insertion order.
    delete DELETE /v1/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}
    Deletes an insertion order.
    get GET /v1/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}
    Gets an insertion order.
    list GET /v1/advertisers/{advertiserId}/insertionOrders
    Lists insertion orders in an advertiser.
    patch PATCH /v1/advertisers/{insertionOrder.advertiserId}/insertionOrders/{insertionOrder.insertionOrderId}
    Updates an existing insertion order.

    REST Resource: v1.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions

    Methods
    get GET /v1/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Gets a single targeting option assigned to an insertion order.
    list GET /v1/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Lists the targeting options assigned to an insertion order.

    REST Resource: v1.advertisers.invoices

    Methods
    list GET /v1/advertisers/{advertiserId}/invoices
    Lists invoices posted for an advertiser in a given month.
    lookupInvoiceCurrency GET /v1/advertisers/{advertiserId}/invoices:lookupInvoiceCurrency
    Retrieves the invoice currency used by an advertiser in a given month.

    REST Resource: v1.advertisers.lineItems

    Methods
    bulkEditLineItemAssignedTargetingOptions POST /v1/advertisers/{advertiserId}/lineItems/{lineItemId}:bulkEditLineItemAssignedTargetingOptions
    Bulk edits targeting options under a single line item.
    bulkListLineItemAssignedTargetingOptions GET /v1/advertisers/{advertiserId}/lineItems/{lineItemId}:bulkListLineItemAssignedTargetingOptions
    Lists assigned targeting options of a line item across targeting types.
    create POST /v1/advertisers/{lineItem.advertiserId}/lineItems
    Creates a new line item.
    delete DELETE /v1/advertisers/{advertiserId}/lineItems/{lineItemId}
    Deletes a line item.
    generateDefault POST /v1/advertisers/{advertiserId}/lineItems:generateDefault
    Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status .
    get GET /v1/advertisers/{advertiserId}/lineItems/{lineItemId}
    Gets a line item.
    list GET /v1/advertisers/{advertiserId}/lineItems
    Lists line items in an advertiser.
    patch PATCH /v1/advertisers/{lineItem.advertiserId}/lineItems/{lineItem.lineItemId}
    Updates an existing line item.

    REST Resource: v1.advertisers.lineItems.targetingTypes.assignedTargetingOptions

    Methods
    create POST /v1/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Assigns a targeting option to a line item.
    delete DELETE /v1/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Deletes an assigned targeting option from a line item.
    get GET /v1/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Gets a single targeting option assigned to a line item.
    list GET /v1/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Lists the targeting options assigned to a line item.

    REST Resource: v1.advertisers.locationLists

    Methods
    create POST /v1/advertisers/{advertiserId}/locationLists
    Creates a new location list.
    get GET /v1/advertisers/{advertiserId}/locationLists/{locationListId}
    Gets a location list.
    list GET /v1/advertisers/{advertiserId}/locationLists
    Lists location lists based on a given advertiser id.
    patch PATCH /v1/advertisers/{advertiserId}/locationLists/{locationList.locationListId}
    Updates a location list.

    REST Resource: v1.advertisers.locationLists.assignedLocations

    Methods
    bulkEdit POST /v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations:bulkEdit
    Bulk edits multiple assignments between locations and a single location list.
    create POST /v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
    Creates an assignment between a location and a location list.
    delete DELETE /v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationId}
    Deletes the assignment between a location and a location list.
    list GET /v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
    Lists locations assigned to a location list.

    REST Resource: v1.advertisers.manualTriggers

    Methods
    activate POST /v1/advertisers/{advertiserId}/manualTriggers/{triggerId}:activate
    Activates a manual trigger.
    create POST /v1/advertisers/{manualTrigger.advertiserId}/manualTriggers
    Creates a new manual trigger.
    deactivate POST /v1/advertisers/{advertiserId}/manualTriggers/{triggerId}:deactivate
    Deactivates a manual trigger.
    get GET /v1/advertisers/{advertiserId}/manualTriggers/{triggerId}
    Gets a manual trigger.
    list GET /v1/advertisers/{advertiserId}/manualTriggers
    Lists manual triggers that are accessible to the current user for a given advertiser ID.
    patch PATCH /v1/advertisers/{manualTrigger.advertiserId}/manualTriggers/{manualTrigger.triggerId}
    Updates a manual trigger.

    REST Resource: v1.advertisers.negativeKeywordLists

    Methods
    create POST /v1/advertisers/{advertiserId}/negativeKeywordLists
    Creates a new negative keyword list.
    delete DELETE /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}
    Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
    get GET /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}
    Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
    list GET /v1/advertisers/{advertiserId}/negativeKeywordLists
    Lists negative keyword lists based on a given advertiser id.
    patch PATCH /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordList.negativeKeywordListId}
    Updates a negative keyword list.

    REST Resource: v1.advertisers.negativeKeywordLists.negativeKeywords

    Methods
    bulkEdit POST /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:bulkEdit
    Bulk edits negative keywords in a single negative keyword list.
    create POST /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords
    Creates a negative keyword in a negative keyword list.
    delete DELETE /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords/{keywordValue}
    Deletes a negative keyword from a negative keyword list.
    list GET /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords
    Lists negative keywords in a negative keyword list.
    replace POST /v1/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:replace
    Replaces all negative keywords in a single negative keyword list.

    REST Resource: v1.advertisers.targetingTypes.assignedTargetingOptions

    Methods
    create POST /v1/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Assigns a targeting option to an advertiser.
    delete DELETE /v1/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Deletes an assigned targeting option from an advertiser.
    get GET /v1/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Gets a single targeting option assigned to an advertiser.
    list GET /v1/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Lists the targeting options assigned to an advertiser.

    REST Resource: v1.combinedAudiences

    Methods
    get GET /v1/combinedAudiences/{combinedAudienceId}
    Gets a combined audience.
    list GET /v1/combinedAudiences
    Lists combined audiences.

    REST Resource: v1.customBiddingAlgorithms

    Methods
    create POST /v1/customBiddingAlgorithms
    Creates a new custom bidding algorithm.
    get GET /v1/customBiddingAlgorithms/{customBiddingAlgorithmId}
    Gets a custom bidding algorithm.
    list GET /v1/customBiddingAlgorithms
    Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies.
    patch PATCH /v1/customBiddingAlgorithms/{customBiddingAlgorithm.customBiddingAlgorithmId}
    Updates an existing custom bidding algorithm.
    uploadScript GET /v1/customBiddingAlgorithms/{customBiddingAlgorithmId}:uploadScript
    Creates a custom bidding script reference object for a script file.

    REST Resource: v1.customBiddingAlgorithms.scripts

    Methods
    create POST /v1/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts
    Creates a new custom bidding script.
    get GET /v1/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts/{customBiddingScriptId}
    Gets a custom bidding script.
    list GET /v1/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts
    Lists custom bidding scripts that belong to the given algorithm.

    REST Resource: v1.customLists

    Methods
    get GET /v1/customLists/{customListId}
    Gets a custom list.
    list GET /v1/customLists
    Lists custom lists.

    REST Resource: v1.firstAndThirdPartyAudiences

    Methods
    create POST /v1/firstAndThirdPartyAudiences
    Creates a FirstAndThirdPartyAudience.
    editCustomerMatchMembers POST /v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudienceId}:editCustomerMatchMembers
    Updates the member list of a Customer Match audience.
    get GET /v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudienceId}
    Gets a first and third party audience.
    list GET /v1/firstAndThirdPartyAudiences
    Lists first and third party audiences.
    patch PATCH /v1/firstAndThirdPartyAudiences/{firstAndThirdPartyAudience.firstAndThirdPartyAudienceId}
    Updates an existing FirstAndThirdPartyAudience.

    REST Resource: v1.floodlightGroups

    Methods
    get GET /v1/floodlightGroups/{floodlightGroupId}
    Gets a Floodlight group.
    patch PATCH /v1/floodlightGroups/{floodlightGroup.floodlightGroupId}
    Updates an existing Floodlight group.

    REST Resource: v1.googleAudiences

    Methods
    get GET /v1/googleAudiences/{googleAudienceId}
    Gets a Google audience.
    list GET /v1/googleAudiences
    Lists Google audiences.

    REST Resource: v1.guaranteedOrders

    Methods
    create POST /v1/guaranteedOrders
    Creates a new guaranteed order.
    editGuaranteedOrderReadAccessors POST /v1/guaranteedOrders/{guaranteedOrderId}:editGuaranteedOrderReadAccessors
    Edits read advertisers of a guaranteed order.
    get GET /v1/guaranteedOrders/{guaranteedOrderId}
    Gets a guaranteed order.
    list GET /v1/guaranteedOrders
    Lists guaranteed orders that are accessible to the current user.
    patch PATCH /v1/guaranteedOrders/{guaranteedOrder.guaranteedOrderId}
    Updates an existing guaranteed order.

    REST Resource: v1.inventorySourceGroups

    Methods
    create POST /v1/inventorySourceGroups
    Creates a new inventory source group.
    delete DELETE /v1/inventorySourceGroups/{inventorySourceGroupId}
    Deletes an inventory source group.
    get GET /v1/inventorySourceGroups/{inventorySourceGroupId}
    Gets an inventory source group.
    list GET /v1/inventorySourceGroups
    Lists inventory source groups that are accessible to the current user.
    patch PATCH /v1/inventorySourceGroups/{inventorySourceGroup.inventorySourceGroupId}
    Updates an inventory source group.

    REST Resource: v1.inventorySourceGroups.assignedInventorySources

    Methods
    bulkEdit POST /v1/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources:bulkEdit
    Bulk edits multiple assignments between inventory sources and a single inventory source group.
    create POST /v1/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources
    Creates an assignment between an inventory source and an inventory source group.
    delete DELETE /v1/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources/{assignedInventorySourceId}
    Deletes the assignment between an inventory source and an inventory source group.
    list GET /v1/inventorySourceGroups/{inventorySourceGroupId}/assignedInventorySources
    Lists inventory sources assigned to an inventory source group.

    REST Resource: v1.inventorySources

    Methods
    create POST /v1/inventorySources
    Creates a new inventory source.
    editInventorySourceReadWriteAccessors POST /v1/inventorySources/{inventorySourceId}:editInventorySourceReadWriteAccessors
    Edits read/write accessors of an inventory source.
    get GET /v1/inventorySources/{inventorySourceId}
    Gets an inventory source.
    list GET /v1/inventorySources
    Lists inventory sources that are accessible to the current user.
    patch PATCH /v1/inventorySources/{inventorySource.inventorySourceId}
    Updates an existing inventory source.

    REST Resource: v1.media

    Methods
    download GET /download/{resourceName=**}
    Downloads media.
    upload POST /media/{resourceName=**}
    POST /upload/media/{resourceName=**}
    Uploads media.

    REST Resource: v1.partners

    Methods
    bulkEditPartnerAssignedTargetingOptions POST /v1/partners/{partnerId}:bulkEditPartnerAssignedTargetingOptions
    Bulk edits targeting options under a single partner.
    get GET /v1/partners/{partnerId}
    Gets a partner.
    list GET /v1/partners
    Lists partners that are accessible to the current user.

    REST Resource: v1.partners.channels

    Methods
    create POST /v1/partners/{partnerId}/channels
    Creates a new channel.
    get GET /v1/partners/{partnerId}/channels/{channelId}
    Gets a channel for a partner or advertiser.
    list GET /v1/partners/{partnerId}/channels
    Lists channels for a partner or advertiser.
    patch PATCH /v1/partners/{partnerId}/channels/{channel.channelId}
    Updates a channel.

    REST Resource: v1.partners.channels.sites

    Methods
    bulkEdit POST /v1/partners/{partnerId}/channels/{channelId}/sites:bulkEdit
    Bulk edits sites under a single channel.
    create POST /v1/partners/{partnerId}/channels/{channelId}/sites
    Creates a site in a channel.
    delete DELETE /v1/partners/{partnerId}/channels/{channelId}/sites/{urlOrAppId}
    Deletes a site from a channel.
    list GET /v1/partners/{partnerId}/channels/{channelId}/sites
    Lists sites in a channel.
    replace POST /v1/partners/{partnerId}/channels/{channelId}/sites:replace
    Replaces all of the sites under a single channel.

    REST Resource: v1.partners.targetingTypes.assignedTargetingOptions

    Methods
    create POST /v1/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Assigns a targeting option to a partner.
    delete DELETE /v1/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Deletes an assigned targeting option from a partner.
    get GET /v1/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}
    Gets a single targeting option assigned to a partner.
    list GET /v1/partners/{partnerId}/targetingTypes/{targetingType}/assignedTargetingOptions
    Lists the targeting options assigned to a partner.

    REST Resource: v1.sdfdownloadtasks

    Methods
    create POST /v1/sdfdownloadtasks
    Creates an SDF Download Task.

    REST Resource: v1.sdfdownloadtasks.operations

    Methods
    get GET /v1/{name=sdfdownloadtasks/operations/*}
    Gets the latest state of an asynchronous SDF download task operation.

    REST Resource: v1.targetingTypes.targetingOptions

    Methods
    get GET /v1/targetingTypes/{targetingType}/targetingOptions/{targetingOptionId}
    Gets a single targeting option.
    list GET /v1/targetingTypes/{targetingType}/targetingOptions
    Lists targeting options of a given type.
    search POST /v1/targetingTypes/{targetingType}/targetingOptions:search
    Searches for targeting options of a given type based on the given search terms.

    REST Resource: v1.users

    Methods
    bulkEditAssignedUserRoles POST /v1/users/{userId}:bulkEditAssignedUserRoles
    Bulk edits user roles for a user.
    create POST /v1/users
    Creates a new user.
    delete DELETE /v1/users/{userId}
    Deletes a user.
    get GET /v1/users/{userId}
    Gets a user.
    list GET /v1/users
    Lists users that are accessible to the current user.
    patch PATCH /v1/users/{user.userId}
    Updates an existing user.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: