Method: advertisers.adAssets.list

Lists ad assets under an advertiser ID.

Only supports the retrieval of assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

HTTP request

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adAssets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser the ad assets belong to.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Must be between 1 and 5000. If unspecified will default to 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageToken

string

Optional. A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to adAssets.list method. If not specified, the first page of results will be returned.

orderBy

string

Optional. Field by which to sort the list. Acceptable values are:

  • entityStatus
  • youtubeVideoAsset.youtubeVideoId
  • adAssetId (default)

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: adAssetId desc.

filter

string

Optional. Allows filtering of the results by ad asset fields.

Supported syntax:

  • A restriction has the form of {field} {operator} {value}.
  • All fields must use the EQUALS (=) operator.

Supported fields:

  • youtubeVideoAsset.youtubeVideoId
  • entityStatus

Examples:

  • All active YouTube video ad assets under an advertiser: entityStatus=ENTITY_STATUS_ACTIVE

Request body

The request body must be empty.

Response body

A response message for adAssets.list.

If successful, the response body contains data with the following structure:

JSON representation
{
  "adAssets": [
    {
      object (AdAsset)
    }
  ],
  "nextPageToken": string
}
Fields
adAssets[]

object (AdAsset)

The list of ad assets. The list will only contain assets of AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

This list will be absent if empty.

nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to adAssets.list method to retrieve the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.