MembershipsLevels: list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
注: このエンドポイントは、個々のクリエイターがチャンネル メンバーシップが有効になっている自身の YouTube チャンネルをリクエストする場合にのみ使用できます。Google または YouTube の担当者に連絡して、アクセス権をリクエストしてください。
リクエストを承認したチャンネルのメンバーシップ レベルを一覧表示します。レベルは暗黙的な表示順序で返されます。このメソッドに API リクエストを行うと、次のいずれかのレスポンスが返されます。
- クリエイターがチャンネル メンバーシップを有効にしていて、料金レベルが設定されている場合、API レスポンスにはレベルのリストが含まれます。
- クリエイターがチャンネル メンバーシップを有効にしても、料金レベルを定義していない場合、API レスポンスには空のリストが含まれます。
- クリエイターがチャンネル メンバーシップを有効にしていない場合、API は
channelMembershipsNotEnabled エラーを返します。
割り当てへの影響: このメソッドを呼び出すと、1 ユニットの割り当てコストが発生します。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/youtube/v3/membershipsLevels
このリクエストには、次のスコープによる認証が必要です。
| 範囲 |
|---|
https://www.googleapis.com/auth/youtube.channel-memberships.creator |
パラメータ
次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
| パラメータ |
| 必須パラメータ |
part |
string
part パラメータは、API レスポンスに含める membershipsLevel リソース プロパティを指定します。パラメータ値は、リソース パーツのカンマ区切りリストです。次のリストは、取得できる部分を示しています。
|
リクエスト本文
このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{
"kind": "youtube#membershipsLevelListResponse",
"etag": etag,
"items": [
membershipsLevel Resource
]
}
プロパティ
次の表は、このリソースで使用されているプロパティの定義を示したものです。
| プロパティ |
kind |
string
API リソースのタイプを識別します。値は youtube#membershipsLevelListResponse です。 |
etag |
etag
このリソースの Etag。 |
items[] |
list
API リクエストを承認したチャネルが所有する membershipsLevel リソースのリスト。 |
エラー
次の表に、このメソッドの呼び出しに対して API から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
| エラーのタイプ |
エラーの詳細 |
説明 |
badRequest (400) |
channelMembershipsNotEnabled |
リクエストを承認するクリエイターのチャンネルで、チャンネル メンバーシップが有効になっていません。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-04-26 UTC。
[null,null,["最終更新日 2024-04-26 UTC。"],[[["\u003cp\u003eThis API endpoint allows individual YouTube creators with channel memberships enabled to retrieve a list of their channel's membership levels.\u003c/p\u003e\n"],["\u003cp\u003eThe API response will either include a list of membership levels, an empty list if memberships are enabled but no levels are set, or an error if memberships are not enabled.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns a JSON response containing the resource type, Etag, and a list of \u003ccode\u003emembershipsLevel\u003c/code\u003e resources.\u003c/p\u003e\n"],["\u003cp\u003eRequests to this method have a quota cost of 1 unit and require authorization with the scope \u003ccode\u003ehttps://www.googleapis.com/auth/youtube.channel-memberships.creator\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003epart\u003c/code\u003e parameter with a string value that can contain either \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003esnippet\u003c/code\u003e, or both, as comma separated values.\u003c/p\u003e\n"]]],["This API endpoint allows individual creators to retrieve channel membership levels for their YouTube channel. A `GET` request requires authorization with the `youtube.channel-memberships.creator` scope and the `part` parameter to specify the properties. The response, in JSON format, lists membership levels or an empty list if levels are undefined. If channel memberships aren't enabled, the API returns a `channelMembershipsNotEnabled` error. This method has a quota cost of 1 unit per call.\n"],null,["# MembershipsLevels: list\n\nNote: This endpoint can only be used by individual creators to make requests for their own, channel-memberships-enabled YouTube channel. Reach out to your Google or YouTube representative to request access.\n\nLists membership levels for the channel that authorized the request. Levels are returned in\nimplicit display order. API requests to this method yield one of the following responses:\n\n- If the creator has enabled channel memberships and has pricing levels, then the API response contains the list of levels.\n- If the creator has enabled channel memberships but has not defined pricing levels, then the API response contains an empty list.\n- If the creator has not enabled channel memberships, the API returns a [channelMembershipsNotEnabled](#errors) error.\n\n**Quota impact:** A call to this method has a\n[quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/membershipsLevels\n```\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube.channel-memberships.creator` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `membershipsLevel` resource properties that the API response will include. The parameter value is a comma-separated list of resource parts. The following list shows the parts that can be retrieved: - `id` - `snippet` |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#membershipsLevelListResponse\",\n \"etag\": etag,\n \"items\": [\n membershipsLevel Resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-----------|--------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#membershipsLevelListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of `membershipsLevel` resources owned by the channel that authorized the API request. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|--------------------|--------------------------------|----------------------------------------------------------------------------------------|\n| `badRequest (400)` | `channelMembershipsNotEnabled` | The creator channel authorizing the request does not have channel memberships enabled. |"]]
