Method: advertisers.lineItems.targetingTypes.assignedTargetingOptions.list

  • The assignedTargetingOptions.list method lists the targeting options assigned to a specific line item.

  • The HTTP request uses a GET method with path parameters for advertiserId, lineItemId, and targetingType.

  • Query parameters like pageSize, pageToken, orderBy, and filter can be used to control the results.

  • The request body must be empty.

  • The response body contains a list of assignedTargetingOptions and a nextPageToken for pagination.

Lists the targeting options assigned to a line item.

HTTP request

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

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

string (int64 format)

Required. The ID of the line item to list assigned targeting options for.
targetingType

enum (TargetingType)

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

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

Examples:

  • AssignedTargetingOptions with ID 1 or 2 assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
  • AssignedTargetingOptions 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.

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