Method: partners.list

    • The partners.list method lists partners accessible to the current user.

    • You can specify the page size, page token, sort order, and filter for the list of partners using query parameters.

    • The HTTP request method is GET and the request body must be empty.

    • The response body contains a list of partner objects and an optional token for the next page of results.

    • This method requires the https://www.googleapis.com/auth/display-video authorization 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/v4/partners

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    pageSize

    integer

    Requested page size. Must be between 1 and 200 . 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 fields.

    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} .
    • All fields must use the EQUALS (=) operator.

    Supported fields:

    • entityStatus

    Examples:

    • All active partners: entityStatus="ENTITY_STATUS_ACTIVE"

    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 
     { 
 "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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: