Method: policies.list

  • This webpage details how to retrieve a list of a content owner's saved policies via the YouTube Partner API's policies.list method.

  • The HTTP request is a GET method to the specified URL, and requires an empty request body.

  • You can retrieve specific policies by providing a comma-separated list of policy IDs in the id query parameter and specify the content owner in the onBehalfOfContentOwner query parameter if needed.

  • The response body will include a list of policies in JSON format with the kind and items fields and also supports sorting by update time in ascending or descending order.

  • To utilize this method, you will need the https://www.googleapis.com/auth/youtubepartner OAuth scope for authorization.

Retrieves a list of the content owner's saved policies.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
id

string

The id parameter specifies a comma-separated list of saved policy IDs to retrieve. Only policies belonging to the currently authenticated content owner will be available.
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.
sort

enum (Sort)

The sort parameter specifies how the search results should be sorted.

Request body

The request body must be empty.

Response body

A list of policies returned in response to a policies.list call.

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

JSON representation 
{
  "kind": string,
  "items": [
    {
      object (Policy)
    }
  ]
}
Fields
kind

string

The type of the API response. For this operation, the value is youtubePartner#policyList.
items[]

object (Policy)

A list of saved policies.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

Sort

Supported sorting orders.

Enums
SORT_UNSPECIFIED Default value.
TIME_UPDATED_ASC Sort by the update time ascending.
TIME_UPDATED_DESC Sort by the update time descending.