Groups: update

    • This API method updates the metadata of a YouTube Analytics group, specifically allowing modification of the group's title.

    • To use this API, you need to authorize with one of several scopes, including yt-analytics.readonly , yt-analytics-monetary.readonly , youtube , or youtubepartner , each providing different levels of access.

    • The API endpoint for updating a group's metadata is PUT https://youtubeanalytics.googleapis.com/v2/groups .

    • The request body must contain a group resource with values specified for the id and snippet.title properties.

    • Content owners managing multiple channels can use the onBehalfOfContentOwner parameter to authenticate once and access data across all their channels.

    Modifies the metadata for a group. Currently, the only property that can be updated is the group's title. (Use the groupItems.insert and groupItems.delete to add and remove group items.)

    Request

    HTTP request

    PUT https://youtubeanalytics.googleapis.com/v2/groups

    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
    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

    Provide a group resource in the request body. For that resource, you must specify a value for the following properties. Note that the request updates the snippet.title field's value.

    • id
    • snippet.title

    Response

    If successful, this method returns a group resource in the response body.

    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.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: