Method: advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

  • Display & Video 360 API v1 has been sunset.

  • This document details how to list targeting options assigned to a campaign for a specified targeting type.

  • The request uses a GET method to a URL specifying the advertiser ID, campaign ID, and targeting type.

  • Path parameters include the required advertiserId, campaignId, and targetingType.

  • Query parameters allow for pagination, sorting, and filtering of the results.

Lists the targeting options assigned to a campaign for a specified targeting type.

HTTP request

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions

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

enum (TargetingType)

Required. Identifies the type of assigned targeting options to list.

Supported targeting types:

Query parameters

Parameters
pageSize

integer

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

string

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

string

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

  • assignedTargetingOptionId (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: assignedTargetingOptionId 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:

  • assignedTargetingOptionId
  • inheritance

Examples:

  • AssignedTargetingOption resources with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
  • 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:

Response message for assignedTargetingOptions.list.

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