GroupItems: list

    • This API method retrieves a collection of group items that match the specified request parameters.

    • Access to this method requires authorization with either the https://www.googleapis.com/auth/youtube scope or the combination of https://www.googleapis.com/auth/youtube.readonly and https://www.googleapis.com/auth/yt-analytics.readonly scopes.

    • The groupId parameter is required to specify the unique ID of the group for which you want to retrieve items.

    • The onBehalfOfContentOwner parameter is an optional parameter allowing content owners to authenticate once to access data for all their channels, and it is intended exclusively for YouTube content partners managing multiple channels.

    • The response body structure includes a kind property identifying the type as youtube#groupItemListResponse , an etag , and an items[] list containing the requested groupItem resources.
    Important: API requests to this method require access to either:
    • the https://www.googleapis.com/auth/youtube scope
      or
    • the https://www.googleapis.com/auth/youtube.readonly scope
      and
      the https://www.googleapis.com/auth/yt-analytics.readonly scope

    The first option uses one scope, which happens to be a read-write scope, while the second option uses two read-only scopes.

    Returns a collection of group items that match the API request parameters.

    Request

    HTTP request

    GET https://youtubeanalytics.googleapis.com/v2/groupItems

    Authorization

    This request requires authorization with at least one of the following scopes ( read more about authentication and authorization ).

    Scopes
    https://www.googleapis.com/auth/yt-analytics.readonly
    View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts.
    https://www.googleapis.com/auth/yt-analytics-monetary.readonly
    View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to estimated revenue and ad performance metrics.
    https://www.googleapis.com/auth/youtube
    Manage your YouTube account. In the YouTube Analytics API, channel owners use this scope to manage YouTube Analytics groups and group items.
    https://www.googleapis.com/auth/youtubepartner
    View and manage YouTube assets and associated content on YouTube. In the YouTube Analytics API, content owners use this scope to manage YouTube Analytics groups and group items.

    Parameters

    The table below lists the parameters that this query supports. All of the parameters listed are query parameters.

    Parameters
    Required parameters
    groupId
    string
    The id parameter specifies the unique ID of the group for which you want to retrieve group items.
    Optional parameters
    onBehalfOfContentOwner
    string
    This parameter can only be used in a properly authorized request . Note:This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels.

    The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

    Request body

    Do not provide a request body when calling this method.

    Response

    If successful, this method returns a response body with the following structure:

    {  
 " kind 
" 
 : 
  
 "youtube#groupItemListResponse" 
 , 
  
 " etag 
" 
 : 
  
  etag 
 
 , 
  
 " items 
" 
 : 
  
 [ 
  
  groupItem 
  
 Resource 
 
  
 ] 
}

    Properties

    The following table defines the properties that appear in this resource:

    Properties
    kind string
    Identifies the API resource's type. The value will be youtube#groupItemListResponse .
    etag etag
    The Etag of this resource.
    items[] list
    A list of items that the group contains. Each item in the list represents a groupItem resource.

    Errors

    The API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the error message documentation.

    Try it!

    Use the APIs Explorer to call this API and see the API request and response.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: