Method: assetRelationships.list

    • This endpoint retrieves a list of relationships for a specific asset, where the asset is either the parent or child in the relationship.

    • The HTTP request uses a GET method and requires the asset ID, content owner, and optionally a page token as query parameters.

    • The request body must be empty, and it uses the https://youtubepartner.googleapis.com/youtube/partner/v1/assetRelationships URL.

    • A successful response contains a paginated list of assetRelationship resources, including information about the kind, page info, items, and a potential next page token.

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

    Retrieves a list of relationships for a given asset. The list contains relationships where the specified asset is either the parent (embedding) or child (embedded) asset in the relationship.

    HTTP request

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

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    assetId

    string

    The assetId parameter specifies the asset ID of the asset for which you are retrieving relationships.
    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 search results.

    Request body

    The request body must be empty.

    Response body

    A paginated list of assetRelationship resources returned in response to a assetRelationships.list request.

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

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

    string

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

    object ( PageInfo )

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

    object ( AssetRelationship )

    A list of assetRelationship 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: