実装: 定期購入

次の例は、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 を使用して承認する必要があります。

  API 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