GroupItems: insert
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リクエスト
HTTP リクエスト
POST https://youtubeanalytics.googleapis.com/v2/groupItems
承認
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
スコープ |
https://www.googleapis.com/auth/yt-analytics.readonly |
YouTube コンテンツの YouTube アナリティクス レポートを表示します。このスコープは再生回数や評価数など、ユーザー アクティビティの指標へのアクセスを提供します。 |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
YouTube コンテンツに関する YouTube アナリティクス収益レポートを表示します。このスコープでは、ユーザー アクティビティの指標、推定収益、広告のパフォーマンス指標にアクセスできます。 |
https://www.googleapis.com/auth/youtube |
YouTube アカウントを管理します。YouTube Analytics API では、チャンネル所有者はこのスコープを使用して YouTube アナリティクスのグループとグループ アイテムを管理します。 |
https://www.googleapis.com/auth/youtubepartner |
YouTube のアセットや関連するコンテンツを YouTube で表示、管理できます。YouTube Analytics API では、コンテンツ所有者はこのスコープを使用して YouTube アナリティクスのグループとグループアイテムを管理します。 |
パラメータ
下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。
パラメータ |
オプション パラメータ |
onBehalfOfContentOwner |
string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、さまざまな YouTube チャンネルを所有して管理している YouTube コンテンツ パートナー専用です。
onBehalfOfContentOwner パラメータは、リクエストの認可認証情報で、パラメータ値で指定されたコンテンツ所有者の代理で行動している YouTube ユーザーを識別することを示します。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザーが認証するアカウントは、指定された YouTube コンテンツ所有者にリンクする必要があります。 |
リクエスト本文
リクエストの本文には groupItem リソースを指定します。
そのリソースには、次のプロパティの値を指定する必要があります。
レスポンス
アイテムが正常に挿入されると、このメソッドはレスポンスの本文で groupItem リソースを返します。
リクエストで指定されたアイテムが、リクエストが行われる前にすでにグループに含まれていた場合、このメソッドは HTTP 204
レスポンス コード(No Content
)を返します。
エラー
次の表は、このメソッドを呼び出したときに API からレスポンスとして返される可能性のあるエラー メッセージの一覧です。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ |
エラーの詳細 |
説明 |
forbidden (403) |
groupContainsMaximumNumberOfItems |
グループにすでに許容されている最大数のアイテムが含まれています。 |
試してみよう:
APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-08-21 UTC。
[null,null,["最終更新日 2025-08-21 UTC。"],[[["\u003cp\u003eThis API endpoint allows you to create a new group item within YouTube Analytics.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using specific scopes, including options for both content owners and channel owners.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include a groupItem resource in the body, specifying the \u003ccode\u003egroupId\u003c/code\u003e and \u003ccode\u003eresource.id\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eA successful insertion of the item returns a groupItem resource, and attempting to add a pre-existing item returns a \u003ccode\u003e204\u003c/code\u003e HTTP code.\u003c/p\u003e\n"],["\u003cp\u003eThe API will return a \u003ccode\u003e403\u003c/code\u003e error if the group has reached its maximum item capacity.\u003c/p\u003e\n"]]],["This documentation details the process of creating a group item via a `POST` request to the YouTube Analytics API (`/groupItems`). Authorization requires specific scopes, including `yt-analytics.readonly`, `yt-analytics-monetary.readonly`, `youtube`, or `youtubepartner`. The request body must include a `groupItem` resource, specifying `groupId` and `resource.id`. Content owners can use `onBehalfOfContentOwner` to authenticate for multiple channels. Successful creation returns the `groupItem` resource; a duplicate returns a `204` status. A `403` error occurs when the maximum number of items is reached.\n"],null,["# GroupItems: insert\n\nCreates a group item.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://youtubeanalytics.googleapis.com/v2/groupItems\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/analytics/authentication)).\n\n| Scopes ||\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n\n### Parameters\n\nThe table below lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). **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. |\n\n### Request body\n\nProvide a [groupItem resource](/youtube/analytics/reference/groupItems#resource) in the request body.\nFor that resource, you must specify a value for the following properties.\n\n\u003cbr /\u003e\n\n- `groupId`\n- `resource.id`\n\n\u003cbr /\u003e\n\nResponse\n--------\n\nIf the item is successfully inserted, this method returns a [groupItem resource](/youtube/analytics/reference/groupItems#resource) in the response body.\n\nIf the item specified in the request had already been included in the group before the request was made, this method returns an HTTP `204` response code (`No Content`).\n\nErrors\n------\n\nThe table below identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/analytics/reference/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|-------------------|-------------------------------------|-----------------------------------------------------------------|\n| `forbidden (403)` | `groupContainsMaximumNumberOfItems` | The group already contains the maximum allowed number of items. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]