Method: advertisers.bulkListAdvertiserAssignedTargetingOptions

  • The advertisers.bulkListAdvertiserAssignedTargetingOptions method lists assigned targeting options of an advertiser across targeting types.

  • The HTTP request is a GET request to https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}:bulkListAdvertiserAssignedTargetingOptions and requires the advertiserId path parameter.

  • The request supports optional query parameters for pagination (pageSize, pageToken), ordering (orderBy), and filtering (filter) by targetingType.

  • The request body must be empty, and a successful response body contains a list of assigned targeting options and a nextPageToken if there are more results.

  • This method requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Lists assigned targeting options of an advertiser across targeting types.

HTTP request

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}:bulkListAdvertiserAssignedTargetingOptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser the line item belongs to.

Query parameters

Parameters
pageSize

integer

Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is '5000'. Returns error code INVALID_ARGUMENT if an invalid value is specified.
pageToken

string

A token that lets the client fetch the next page of results. Typically, this is the value of nextPageToken returned from the previous call to advertisers.bulkListAdvertiserAssignedTargetingOptions method. If not specified, the first page of results will be returned.
orderBy

string

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

  • targetingType (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: targetingType desc.
filter

string

Allows filtering by assigned targeting option properties. Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by the logical operator OR..
  • A restriction has the form of {field} {operator} {value}.
  • The operator must be EQUALS (=).
  • Supported fields:
    • targetingType

Examples:

  • targetingType with value TARGETING_TYPE_CHANNEL targetingType="TARGETING_TYPE_CHANNEL"

The length of this field should be no more than 500 characters.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "assignedTargetingOptions": [
    {
      object (AssignedTargetingOption)
    }
  ],
  "nextPageToken": string
}
Fields
assignedTargetingOptions[]

object (AssignedTargetingOption)

The list of assigned targeting options.

This list will be absent if empty.
nextPageToken

string

A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assignedTargetingOptions to return.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.