Method: advertisers.lineItems.bulkListAssignedTargetingOptions

  • This page details how to list assigned targeting options for multiple line items across targeting types using an HTTP GET request.

  • The request requires the advertiserId as a path parameter and lineItemIds[] as a required query parameter.

  • Optional query parameters include pageSize, pageToken, orderBy, and filter for controlling the results.

  • The response body contains a list of LineItemAssignedTargetingOption objects, each linking a targeting option to a line item, and a nextPageToken for pagination.

  • The LineItemAssignedTargetingOption object includes the lineItemId and the assignedTargetingOption resource.

Lists assigned targeting options for multiple line items across targeting types.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

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

Query parameters

Parameters
lineItemIds[]

string (int64 format)

Required. The IDs of the line items to list assigned targeting options for.
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 the lineItems.bulkListAssignedTargetingOptions method. If not specified, the first page of results will be returned.
orderBy

string

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

  • lineItemId (default)
  • assignedTargetingOption.targetingType

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 logical operator OR on the same field.
  • 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_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL: targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"
  • 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 
{
  "lineItemAssignedTargetingOptions": [
    {
      object (LineItemAssignedTargetingOption)
    }
  ],
  "nextPageToken": string
}
Fields
lineItemAssignedTargetingOptions[]

object (LineItemAssignedTargetingOption)

The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to.

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 call to lineItems.bulkListAssignedTargetingOptions to fetch the next page of results. This token will be absent if there are no more lineItemAssignedTargetingOptions 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.

LineItemAssignedTargetingOption

Wrapper object associating an assignedTargetingOption resource and the line item it is assigned to.

JSON representation 
{
  "lineItemId": string,
  "assignedTargetingOption": {
    object (AssignedTargetingOption)
  }
}
Fields
lineItemId

string (int64 format)

The ID of the line item the assigned targeting option is assigned to.
assignedTargetingOption

object (AssignedTargetingOption)

The assigned targeting option resource.