Method: whitelists.list

    • This endpoint retrieves a list of whitelisted YouTube channels associated with a specific content owner.

    • The HTTP request is a GET method to the provided URL, using gRPC Transcoding syntax.

    • Requests require parameters such as id (channel IDs), onBehalfOfContentOwner (content owner identification), and pageToken (for pagination) which can be specified as query parameters.

    • The request body must be empty, while a successful response returns a paginated JSON list of whitelist resources, including metadata like kind , pageInfo , items , and nextPageToken .

    • Authorization for this request requires the https://www.googleapis.com/auth/youtubepartner OAuth scope.

    Retrieves a list of whitelisted channels for a content owner.

    HTTP request

    GET https://youtubepartner.googleapis.com/youtube/partner/v1/whitelists

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    id

    string

    The id parameter specifies a comma-separated list of YouTube channel IDs that identify the whitelisted channels you want to retrieve.
    onBehalfOfContentOwner

    string

    The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.
    pageToken

    string

    The pageToken parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken value from the previous API response to retrieve the next page of results.

    Request body

    The request body must be empty.

    Response body

    A paginated list whitelist resources returned in response to a whitelist.list request.

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

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "pageInfo" 
 : 
 { 
 object (  PageInfo 
 
) 
 } 
 , 
 "items" 
 : 
 [ 
 { 
 object (  Whitelist 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    kind

    string

    The type of the API response. For this operation, the value is youtubePartner#whitelistList .
    pageInfo

    object ( PageInfo )

    The pageInfo object encapsulates paging information for the result set.
    items[]

    object ( Whitelist )

    A list of whitelist resources that match the request criteria.
    nextPageToken

    string

    The token that can be used as the value of the pageToken parameter to retrieve the next page of results.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: