Method: campaigns.list

    • This endpoint retrieves a list of campaigns associated with a specific content owner via a GET request to the provided URL.

    • The onBehalfOfContentOwner query parameter is used to specify the content owner for whom the campaigns are being retrieved.

    • The pageToken query parameter allows for the retrieval of paginated results, referencing the nextPageToken from prior requests.

    • The request body must be empty, and the response will be a JSON object containing a list of campaigns under the items field.

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

    Retrieves a list of campaigns for an owner.

    HTTP request

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

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    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. For example, 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

    campaigns.list campaigns associated with the content owner.

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

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

    string

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

    object ( Campaign )

    A list of campaigns.

    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: