General
What's the latest version of the API?
The latest version of the API that this document addresses is
v3
.
Can I retrieve performance data using this API?
No. Use the Bid Manager API to create, retrieve, and run Display & Video 360 offline reports.
Use the API
What URL do I use to access the API?
https://displayvideo.googleapis.com
What methods of authentication are supported?
OAuth 2.0 is the only supported method of authentication.
Display & Video 360 API requests must be authorized for the following scope:
https://www.googleapis.com/auth/display-video
Requests to the users
service must also be authorized for the
following additional scope:
https://www.googleapis.com/auth/display-video-user-management
I want to write code. Where can I find client libraries?
Refer to the client library guide.
What if I don't want to use a client library?
We recommend that you use one of our client libraries but you can also interact with the Display & Video 360 API using direct HTTP requests.
Some more involved methods, such as advertisers.assets.upload
and media.upload
, are harder to translate directly to HTTP
requests. See examples of HTTP requests to these methods using cURL on our
Creative and Custom Bidding guides.
What Display & Video 360 permissions do I need?
In order to use the Display & Video 360 API, the authenticating Google Account must be a Display & Video 360 user with access to relevant partners or advertisers.
The Display & Video 360 user must have one of the following user roles for the relevant partners or advertisers to do the following actions:
- Read only: Retrieve resources using
get
orlist
calls, excludinguser
resources. - Standard: Retrieve, create, and update resources. Retrieve
user
resources with permissions to the same partners or advertisers. - Admin: Retrieve, create, and update resources. Retrieve, create and grant
access to
user
resources for the partners or advertisers you administrate.
How do I update YouTube & Partners resources using the API?
The Display & Video 360 API does not support creating or updating YouTube & Partners resources. Create or update YouTube & Partners resources in bulk by uploading Structured Data Files (SDF) in the Display & Video 360 interface. For more details on how to use SDF upload, read our guide page about YouTube & Partners resources.
How do I target geographic locations?
Geographic targeting can be assigned to line items using the following targeting types:
TARGETING_TYPE_GEO_REGION
TARGETING_TYPE_POI
TARGETING_TYPE_BUSINESS_CHAIN
TARGETING_TYPE_REGIONAL_LOCATION_LIST
TARGETING_TYPE_PROXIMITY_LOCATION_LIST
Retrieve targeting option IDs for the first three targeting types using
targetingTypes.targetingOptions.search
. Retrieve and manage
location list resources using the advertisers.locationLists
service.
In addition, you can also build a TARGETING_TYPE_POI
targeting option
ID to directly target a proximity radius around
specific latitude-longitude coordinates.
I see that I can download Structured Data Files (SDFs) using the API, but how do I upload them?
The Display & Video 360 API does not support SDF upload. We recommend managing
resources through CREATE
, PATCH
, and DELETE
methods
provided by the API instead. If you still want to manage resources using SDFs,
those files can be updated in the Display & Video 360 interface.
Support
Does the API have any known issues or limitations?
There are limits on the number of requests your project can make per second, which are outlined in our usage limits guide.