実装: サブスクリプション

次の例は、YouTube Data API（v3）を使用して定期購入に関連する機能を実行する方法を示しています。

チャンネル登録を取得する

特定のチャンネルの登録を取得するには、subscriptions.list メソッドを呼び出します。チャンネルを識別する方法は 2 つあります。

• 現在認証されているユーザーのサブスクリプションを取得するには、mine パラメータの値を true に設定します。mine パラメータを使用するリクエストは、OAuth 2.0 を使用して承認する必要があります。

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list?
          part=snippet,contentDetails
          &mine=true

• 他のチャンネルのチャンネル登録を取得するには、channelId パラメータの値を、そのチャンネルの一意の YouTube チャンネル ID に設定します。以下の例は、YouTube の TED チャンネルからチャンネル登録されたチャンネルのリストを取得します。

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list?
          part=snippet,contentDetails
          &channelId=UCAuUUnT6oDeKwE6v1NGQxug

  注: 指定されたチャンネルが登録チャンネルを公開しておらず、チャンネルの所有者がリクエストを承認していない場合、API は 403 (Forbidden) HTTP レスポンス コードを返します。

コードサンプルについては、subscriptions.list メソッドのドキュメントをご覧ください。

サブスクリプションの追加

subscriptions.insert メソッドを呼び出して、チャンネル登録を追加します。このリクエストは、OAuth 2.0 を使用して承認する必要があります。リクエストの本文は、次の値を設定する subscription リソースです。

• snippet.resourceId.kind には値 youtube#channel が含まれます。
• snippet.resourceId.channelId プロパティは、登録しているチャンネルを示します。プロパティ値は一意の YouTube チャンネル ID です。チャンネル ID を取得するには、channels.list メソッドの呼び出しや、チャンネルの検索結果の取得など、複数の方法があります。

以下の API リクエストは、YouTube の TED チャンネルに登録しています:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.insert?
        part=snippet

リクエストの本文は次のようになります。

{
  "snippet": {
    "resourceId": {
      "kind": "youtube#channel",
      "videoId": "UCAuUUnT6oDeKwE6v1NGQxug"
    }
  }
}

コードサンプルについては、subscriptions.insert メソッドのドキュメントをご覧ください。

サブスクリプションの削除

この例では、サブスクリプションを削除します。このリクエストは、OAuth 2.0 を使用して承認する必要があります。この例には次の 2 つのステップがあります。

• ステップ 1: 認証済みユーザーのチャンネル登録を取得する

  サブスクリプションのリストを取得するには、subscriptions.list メソッドを呼び出します。チャンネル登録の取得に関する上の例では、このリクエストを行う方法について説明します。

  API を呼び出すアプリケーションは API レスポンスを処理し、各サブスクリプションの ID をキーとして使用してサブスクリプションのリストを表示できます。レスポンスでは、各アイテムの id プロパティが、対応するサブスクリプションを一意に識別するサブスクリプション ID を識別します。この値は、次のステップでリストから削除できます。

• ステップ 2: サブスクリプションを削除する

  サブスクリプションを削除するには、subscriptions.delete メソッドを呼び出します。リクエストの id パラメータを、削除するサブスクリプションのサブスクリプション ID に設定します。このリクエストは、OAuth 2.0 を使用して承認する必要があります。

  APIs Explorer でリクエストを完了するには、id プロパティの値を設定する必要があります。

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.delete?
          id=SUBSCRIPTION_ID

コードサンプルについては、subscriptions.delete メソッドのドキュメントをご覧ください。

承認済みユーザーのチャンネルの登録者リストを取得する

現在認証されているユーザーのチャンネルに登録するチャンネルのリストを取得するには、subscriptions.list メソッドを呼び出し、mySubscribers パラメータの値を true に設定します。リクエストは、OAuth 2.0 を使用して承認する必要があります。

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list?
        part=snippet,contentDetails
        &mySubscribers=true