Method: advertisers.campaigns.listAssignedTargetingOptions

  • This document details the HTTP request, path and query parameters, request and response bodies, and authorization scopes for listing assigned targeting options of a campaign across targeting types.

  • The HTTP request uses a GET method with a specific URL structure including advertiser and campaign IDs.

  • Path parameters require the advertiserId and campaignId as required string values formatted as int64.

  • Query parameters allow for pagination using pageSize and pageToken, sorting with orderBy, and filtering using filter.

  • The request body must be empty, and the response body contains a list of assignedTargetingOptions and a nextPageToken for pagination.

  • The required authorization scope is https://www.googleapis.com/auth/display-video.

Lists assigned targeting options of a campaign across targeting types.

HTTP request

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/campaigns/{campaignId}:listAssignedTargetingOptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser the campaign belongs to.
campaignId

string (int64 format)

Required. The ID of the campaign to list assigned targeting options for.

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 BulkListCampaignAssignedTargetingOptions 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 fields.

Supported syntax:

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

Supported fields:

  • targetingType
  • inheritance

Examples:

  • AssignedTargetingOption resources of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER: targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"
  • AssignedTargetingOption resources with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER: inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

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

Reference our filter LIST requests guide for more information.

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 BulkListCampaignAssignedTargetingOptionsRequest 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.