Skip to content
OpenParablePublic APIs

Display & Video 360 API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

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.

Display & Video 360 API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 151 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://displayvideo.googleapis.com/
Version
v2
Endpoints
151
OpenAPI
Specification ↗
Spec updated
2023-04-20

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://displayvideo.googleapis.com/v2/advertisers" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://displayvideo.googleapis.com/v2/advertisers", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://displayvideo.googleapis.com/v2/advertisers",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/download/{resourceName}Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including
POST/media/{resourceName}Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without inc
GET/v2/advertisersLists 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 listin
POST/v2/advertisersCreates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.
GET/v2/advertisers/{advertiserId}Gets an advertiser.
PATCH/v2/advertisers/{advertiserId}Updates an existing advertiser. Returns the updated advertiser if successful.
DELETE/v2/advertisers/{advertiserId}Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted adverti
POST/v2/advertisers/{advertiserId}/assetsUploads 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, a
GET/v2/advertisers/{advertiserId}/campaignsLists 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_A
POST/v2/advertisers/{advertiserId}/campaignsCreates a new campaign. Returns the newly created campaign if successful.
GET/v2/advertisers/{advertiserId}/campaigns/{campaignId}Gets a campaign.
PATCH/v2/advertisers/{advertiserId}/campaigns/{campaignId}Updates an existing campaign. Returns the updated campaign if successful.
DELETE/v2/advertisers/{advertiserId}/campaigns/{campaignId}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
GET/v2/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptionsLists the targeting options assigned to a campaign for a specified targeting type.
GET/v2/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Gets a single targeting option assigned to a campaign.
GET/v2/advertisers/{advertiserId}/campaigns/{campaignId}:listAssignedTargetingOptionsLists assigned targeting options of a campaign across targeting types.
GET/v2/advertisers/{advertiserId}/channelsLists channels for a partner or advertiser.
POST/v2/advertisers/{advertiserId}/channelsCreates a new channel. Returns the newly created channel if successful.
PATCH/v2/advertisers/{advertiserId}/channels/{channelId}Updates a channel. Returns the updated channel if successful.
GET/v2/advertisers/{advertiserId}/channels/{channelId}/sitesLists sites in a channel.
DELETE/v2/advertisers/{advertiserId}/channels/{channelId}/sites/{urlOrAppId}Deletes a site from a channel.
POST/v2/advertisers/{advertiserId}/channels/{channelId}/sites:bulkEditBulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided i
POST/v2/advertisers/{advertiserId}/channels/{channelId}/sites:replaceReplaces 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.
GET/v2/advertisers/{advertiserId}/creativesLists 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_A
POST/v2/advertisers/{advertiserId}/creativesCreates a new creative. Returns the newly created creative if successful.
GET/v2/advertisers/{advertiserId}/creatives/{creativeId}Gets a creative.
PATCH/v2/advertisers/{advertiserId}/creatives/{creativeId}Updates an existing creative. Returns the updated creative if successful.
DELETE/v2/advertisers/{advertiserId}/creatives/{creativeId}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_STAT
GET/v2/advertisers/{advertiserId}/insertionOrdersLists 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 `E
POST/v2/advertisers/{advertiserId}/insertionOrdersCreates a new insertion order. Returns the newly created insertion order if successful.
GET/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
PATCH/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}Updates an existing insertion order. Returns the updated insertion order if successful.
DELETE/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}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_
GET/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptionsLists the targeting options assigned to an insertion order.
POST/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptionsAssigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` *
GET/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Gets a single targeting option assigned to an insertion order.
DELETE/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TY
GET/v2/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}:listAssignedTargetingOptionsLists assigned targeting options of an insertion order across targeting types.
GET/v2/advertisers/{advertiserId}/invoicesLists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this
GET/v2/advertisers/{advertiserId}/invoices:lookupInvoiceCurrencyRetrieves the invoice currency used by an advertiser in a given month.
GET/v2/advertisers/{advertiserId}/lineItemsLists 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
POST/v2/advertisers/{advertiserId}/lineItemsCreates a new line item. Returns the newly created line item if successful.
GET/v2/advertisers/{advertiserId}/lineItems/{lineItemId}Gets a line item.
PATCH/v2/advertisers/{advertiserId}/lineItems/{lineItemId}Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests up
DELETE/v2/advertisers/{advertiserId}/lineItems/{lineItemId}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_S
GET/v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptionsLists the targeting options assigned to a line item.
POST/v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptionsAssigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the f
GET/v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Gets a single targeting option assigned to a line item.
DELETE/v2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}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
POST/v2/advertisers/{advertiserId}/lineItems/{lineItemId}:duplicateDuplicates a line item. Returns the ID of the created line item if successful.
POST/v2/advertisers/{advertiserId}/lineItems:bulkEditAssignedTargetingOptionsBulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsReq
GET/v2/advertisers/{advertiserId}/lineItems:bulkListAssignedTargetingOptionsLists assigned targeting options for multiple line items across targeting types.
POST/v2/advertisers/{advertiserId}/lineItems:bulkUpdateUpdates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTa
POST/v2/advertisers/{advertiserId}/lineItems:generateDefaultCreates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly cre
GET/v2/advertisers/{advertiserId}/locationListsLists location lists based on a given advertiser id.
POST/v2/advertisers/{advertiserId}/locationListsCreates a new location list. Returns the newly created location list if successful.
PATCH/v2/advertisers/{advertiserId}/locationLists/{locationListId}Updates a location list. Returns the updated location list if successful.
GET/v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocationsLists locations assigned to a location list.
POST/v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocationsCreates an assignment between a location and a location list.
DELETE/v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationId}Deletes the assignment between a location and a location list.
POST/v2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations:bulkEditBulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocat
GET/v2/advertisers/{advertiserId}/manualTriggersLists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id
POST/v2/advertisers/{advertiserId}/manualTriggersCreates a new manual trigger. Returns the newly created manual trigger if successful.
GET/v2/advertisers/{advertiserId}/manualTriggers/{triggerId}Gets a manual trigger.
PATCH/v2/advertisers/{advertiserId}/manualTriggers/{triggerId}Updates a manual trigger. Returns the updated manual trigger if successful.
POST/v2/advertisers/{advertiserId}/manualTriggers/{triggerId}:activateActivates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.
POST/v2/advertisers/{advertiserId}/manualTriggers/{triggerId}:deactivateDeactivates a manual trigger.
GET/v2/advertisers/{advertiserId}/negativeKeywordListsLists negative keyword lists based on a given advertiser id.
POST/v2/advertisers/{advertiserId}/negativeKeywordListsCreates a new negative keyword list. Returns the newly created negative keyword list if successful.
PATCH/v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}Updates a negative keyword list. Returns the updated negative keyword list if successful.
GET/v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywordsLists negative keywords in a negative keyword list.
DELETE/v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords/{keywordValue}Deletes a negative keyword from a negative keyword list.
POST/v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:bulkEditBulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.dele
POST/v2/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListId}/negativeKeywords:replaceReplaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in R
GET/v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptionsLists the targeting options assigned to an advertiser.
POST/v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptionsAssigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
GET/v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Gets a single targeting option assigned to an advertiser.
DELETE/v2/advertisers/{advertiserId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Deletes an assigned targeting option from an advertiser.
GET/v2/advertisers/{advertiserId}/youtubeAdGroupAdsLists YouTube ad group ads.
GET/v2/advertisers/{advertiserId}/youtubeAdGroupAds/{youtubeAdGroupAdId}Gets a YouTube ad group ad.
GET/v2/advertisers/{advertiserId}/youtubeAdGroupsLists YouTube ad groups.
GET/v2/advertisers/{advertiserId}/youtubeAdGroups/{youtubeAdGroupId}Gets a YouTube ad group.
GET/v2/advertisers/{advertiserId}/youtubeAdGroups/{youtubeAdGroupId}/targetingTypes/{targetingType}/assignedTargetingOptionsLists the targeting options assigned to a YouTube ad group. Inherited assigned targeting options are not included.
GET/v2/advertisers/{advertiserId}/youtubeAdGroups/{youtubeAdGroupId}/targetingTypes/{targetingType}/assignedTargetingOptions/{assignedTargetingOptionId}Gets a single targeting option assigned to a YouTube ad group. Inherited assigned targeting options are not included.
GET/v2/advertisers/{advertiserId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptionsLists assigned targeting options for multiple YouTube ad groups across targeting types. Inherieted assigned targeting options are not included.
GET/v2/advertisers/{advertiserId}:auditAudits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource
POST/v2/advertisers/{advertiserId}:editAssignedTargetingOptionsEdits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptio
GET/v2/advertisers/{advertiserId}:listAssignedTargetingOptionsLists assigned targeting options of an advertiser across targeting types.
GET/v2/combinedAudiencesLists combined audiences. The order is defined by the order_by parameter.
GET/v2/combinedAudiences/{combinedAudienceId}Gets a combined audience.
GET/v2/customBiddingAlgorithmsLists 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.
POST/v2/customBiddingAlgorithmsCreates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
GET/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}Gets a custom bidding algorithm.
PATCH/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.
GET/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}/scriptsLists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
POST/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}/scriptsCreates a new custom bidding script. Returns the newly created script if successful.
GET/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts/{customBiddingScriptId}Gets a custom bidding script.
GET/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}:uploadScriptCreates 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 u
GET/v2/customListsLists custom lists. The order is defined by the order_by parameter.
GET/v2/customLists/{customListId}Gets a custom list.

Showing the first 100 of 151 endpoints; the full list is in the documentation.

Questions

Does the Display & Video 360 API API need an API key?

Yes. The Display & Video 360 API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Display & Video 360 API API support HTTPS?

Yes, the Display & Video 360 API API is served over HTTPS.

How many endpoints does the Display & Video 360 API API have?

Its OpenAPI description lists 151 endpoints in version v2. The first 100 are shown on this page.

What are alternatives to the Display & Video 360 API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).