Method: sellers.adUnits.list

  • The adUnits.list method lists ad units for a specified seller.

  • The HTTP request uses a GET method with a URL containing the parent seller and adUnits endpoint.

  • Path parameters include the required parent seller.

  • Query parameters allow for filtering, ordering, pagination, and including soft-deleted ad units.

  • The response body contains a list of ad units and a token for the next page of results.

Lists ad units.

  • For example GET /v1/sellers/seller111/adUnits
  • Returns a list of ad units and a token to retrieve the next page if successful.
  • Returns error code PERMISSION_DENIED if the user does not have access to the seller or seller id does not exist.
  • Returns error code INVALID_ARGUMENT if sellers provide an invalid page size or page token.

HTTP request

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/adUnits

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The seller, which owns this collection of ad units. Format: sellers/{seller}

Query parameters

Parameters
pageSize

integer

The maximum number of items to return. The service may return fewer than this value. Max allowed number of ad units is 1000; values above 1000 will be changed to 1000. If unspecified, at most 1000 ad units will be returned.
pageToken

string

The nextPageToken value returned from a previous List request, if any.
filter

string

The list filter. Currently supports external ID and state filtering, with the syntax: "externalId = [EXTERNAL_ID]" and "state = [STATE]". The logical operators AND and OR can be used to chain filters. AD_UNIT_STATE_DELETED cannot be used to show deleted ad units, use showDeleted instead.
orderBy

string

The order by string used to specify the sort order of the results. Currently supports ordering by updateTime, provide "updateTime" to get results sorted by updateTime in ascending order, or "updateTime desc" for descending order.
showDeleted

boolean

Whether to return soft-deleted ad units.

Request body

The request body must be empty.

Response body

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

Response message for InventoryService.ListAdUnits.

JSON representation 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Fields
adUnits[]

object (AdUnit)

The list of ad units.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to adUnits.list method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/doubleclickbidmanager

For more information, see the OAuth 2.0 Overview.