Method: partners.list

  • This document describes how to list partners accessible to the current user using an HTTP GET request.

  • The HTTP request uses query parameters like pageSize, pageToken, orderBy, and filter to control the returned list.

  • The request body must be empty, and the response body contains a list of partners and a token for the next page of results.

  • The API call requires authorization using the https://www.googleapis.com/auth/display-video OAuth scope.

Lists partners that are accessible to the current user.

The order is defined by the orderBy parameter.

HTTP request

GET https://displayvideo.googleapis.com/v1beta2/partners

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 100. If unspecified will default to 100.
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 partners.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:

  • displayName

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.
filter

string

Allows filtering by partner properties.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • The operator must be EQUALS (=).
  • Supported fields:
    • entityStatus

Examples:

  • All active partners: entityStatus="ENTITY_STATUS_ACTIVE"

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:

JSON representation 
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Fields
partners[]

object (Partner)

The list of partners.

This list will be absent if empty.
nextPageToken

string

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.