Data API コード スニペット

手順

インタラクティブなコード スニペット ツールを使用すると、API リクエストを簡単にテストし、それらのリクエストに固有のコードサンプルを生成できます。ツールに 1 つ以上のユースケースのコード スニペットが表示され、各ユースケースはそのメソッドを呼び出す一般的な方法について説明しています。たとえば、channels.list メソッドを呼び出して、特定のチャンネルや現在のユーザーのチャンネルに関するデータを取得できます。

API リクエストを実行する

リクエスト パラメータのリストの横にある [Execute] ボタンをクリックすると、リクエストを実行できます。ユーザーに代わって API リクエストを送信するアプリケーションを認可していない場合、プロンプトが表示されます。特に予防措置として、リクエストによって書き込み操作(チャンネルに関連付けられたリソースの挿入、更新、削除)が行われる場合は、実際に実行する前に確認メッセージを確認するように求められます。

コード スニペットと完全なサンプルを切り替える

このツールは、ユースケースごとに、呼び出される特定のメソッドに固有のコードを識別するコード スニペットを表示します。各スニペットは、呼び出されるメソッドと、API リクエストで使用されるパラメータ値とプロパティ値を識別します。

さらに、完全なコード サンプルも用意されています。このコードは、API リクエストの承認と API リクエストの作成を行うためのボイラープレート関数を定義するテンプレートにコード スニペットを挿入します。サンプルの上にあるスライダーを使用して、スニペットと完全なサンプルを切り替えることができます。

完全なサンプルコードをローカルで実行する

完全なコードサンプルは、ローカルでコピーして実行するように設計されています。次の前提条件に留意し、完全なコードサンプルを実行する手順を設定してください。

Java

前提条件

  • Java 1.7 以降
  • Gradle 2.3 以降

プロジェクトを設定してコードサンプルを実行する

  1. API Console でプロジェクトを作成し、ウェブ アプリケーションの認証情報を設定します。必要に応じて、承認済みのリダイレクト URI を設定します。

  2. API Java クイックスタート ガイドの手順に沿ってプロジェクトを準備します。ただし、デフォルトの build.gradle ファイルの内容を次のコードで置き換えます。

    apply plugin: 'java'
    apply plugin: 'application'
    
    mainClassName = 'ApiExample'
    sourceCompatibility = 1.7
    targetCompatibility = 1.7
    version = '1.0'
    
    repositories {
        mavenCentral()
    }
    
    dependencies {
        compile 'com.google.api-client:google-api-client:1.22.0'
        compile 'com.google.oauth-client:google-oauth-client-jetty:1.22.0'
        compile 'com.google.apis:google-api-services-youtube:v3-rev182-1.22.0'
        compile group: 'com.google.code.gson', name: 'gson', version: '1.7.2'
        compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.4.4'
    }
    
    compileJava {
        options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation"
    }
  3. 作業ディレクトリから、認証情報に関連付けられた client_secrets.json ファイルを src/main/resources/client_secret.json に保存します。

  4. 作業ディレクトリから完全なコードサンプルを src/main/java/ApiExample.java にコピーします。(各サンプルのクラス名は ApiExample であるため、異なるサンプルを実行するために build.gradle ファイルを変更する必要はありません)。

  5. コマンドラインからサンプルを実行します。

    gradle -q run
  6. ほとんどのサンプルでは、STDOUT に何かが出力されます。また、YouTube のウェブサイトでは、プレイリストやチャンネル セクションの作成リクエストなど、データの書き込みをリクエストする影響を確認することもできます。

JavaScript
  1. API Console でプロジェクトを作成し、ウェブ アプリケーションの認証情報を設定します。リクエストの JavaScript 生成元を設定して、リクエストの送信元 URL(http://localhost など)を識別します。

  2. ウェブサーバーにアクセス可能なローカル ファイル(例: /var/www/html/example.html)にコードサンプル全体をコピーします。

  3. コードサンプルの中で、リクエストに使用するクライアント ID を設定した行を見つけ、値を認証情報のクライアント ID に置き換えます。

    gapi.client.init({
        'clientId': 'REPLACE_ME',
  4. ブラウザでファイル(http://localhost/example.html など)を開きます。Google Chrome などのデバッグ コンソールのブラウザを使用することをおすすめします。

  5. 必要に応じてリクエストを承認します。リクエストが認可されると、デバッグ コンソールにはリクエストに対する API レスポンスが JSON オブジェクトとして表示されるはずです。

Node.js

前提条件

  • Node.js がインストールされている必要があります。
  • npm パッケージ管理ツール(Node.js に付属)。
  • Node.js 用 Google API クライアント ライブラリ:
    npm install googleapis --save
  • インターネットとウェブブラウザへのアクセス。
  • Google アカウント

プロジェクトを設定してコードサンプルを実行する

  1. API Console でプロジェクトを作成し、Google API Console で OAuth 2.0 の認証情報を設定します。認証情報を設定する際に、アプリケーションの種類を [その他] に設定します。

  2. 認証情報に関連付けられている client_secret.json ファイルをローカル ファイルに保存します。

  3. 完全なコードサンプルを client_secret.json ファイルと同じディレクトリのローカル ファイルにコピーします(または、ファイルの場所を正しく識別するようにサンプルを変更します。

  4. コマンドラインからサンプルを実行します。

    node sample.js
  5. ほとんどのサンプルでは、STDOUT に出力します。ウェブ アプリケーションの場合、表示しているウェブページに出力します。また、YouTube のウェブサイトでは、プレイリストやチャンネル セクションの作成リクエストなど、データの書き込みをリクエストする影響を確認することもできます。

Python

前提条件

  • Python 2.6 以降
  • pip パッケージ管理ツール
  • Python 用 Google API クライアント ライブラリ:
    pip install --upgrade google-api-python-client
  • ユーザー認証用の google-auth、google-auth-oauthlib、google-auth-httplib2。
    pip install --upgrade google-auth google-auth-oauthlib google-auth-httplib2
  • Flask Python ウェブ アプリケーション フレームワーク(ウェブサーバー アプリケーション用の Python サンプルを実行している場合)
    pip install --upgrade flask
  • リクエスト HTTP ライブラリ。
    pip install --upgrade requests

プロジェクトを設定してコードサンプルを実行する

  1. API Console でプロジェクトを作成し、Google API Console で OAuth 2.0 の認証情報を設定します。認証情報を設定するときに、Flask Python ウェブ アプリケーション フレームワークを使用するサンプルのアプリケーション タイプを [Web application] に設定し、それらの認証情報に対して承認済みのリダイレクト URI を設定します。それ以外の場合は、アプリケーションの種類を [その他] に設定します。

  2. 認証情報に関連付けられている client_secret.json ファイルをローカル ファイルに保存します。

  3. 完全なコードサンプルを client_secret.json ファイルと同じディレクトリのローカル ファイルにコピーします(または、ファイルの場所を正しく識別するようにサンプルを変更します。

  4. コマンドラインからサンプルを実行します。

    python sample.py
    ウェブサーバー アプリケーションに関する注意事項:

    ウェブサーバー アプリケーション用の Python サンプルを実行している場合、スクリプトを実行するとローカル ウェブサーバーが起動します。API リクエストを実際に実行するには、ブラウザで配信されるウェブページに移動する必要があります。たとえば、Flask ウェブ アプリケーション フレームワークを使用する Python サンプルには、次のような行が含まれています。

    app.run('localhost', 8080, debug=True)

    このコードは、http://localhost:8080 でローカル ウェブサーバーを起動します。ただし、このスクリプトは、ブラウザで実際に http://localhost:8080 に移動するまで API リクエストを実行しません。(ローカル サーバーの URL は、認証情報の承認済みリダイレクト URI としても設定する必要があります)。
  5. ほとんどのサンプルでは、STDOUT に出力します。ウェブ アプリケーションの場合、表示しているウェブページに出力します。また、YouTube のウェブサイトでは、プレイリストやチャンネル セクションの作成リクエストなど、データの書き込みをリクエストする影響を確認することもできます。

PHP

前提条件

  • PHP 5.4 以降(コマンドライン インターフェース(CLI)と JSON 拡張機能がインストールされていること)
  • Composer 依存関係管理ツール。
  • PHP の Google API クライアント ライブラリ:
    php composer.phar require google/apiclient:^2.0

プロジェクトを設定してコードサンプルを実行する

  1. API Console でプロジェクトを作成し、Google API Console で OAuth 2.0 の認証情報を設定します。認証情報を設定する際に、アプリケーションの種類を [その他] に設定します。

  2. 認証情報に関連付けられている client_secret.json ファイルをローカル ファイルに保存します。

  3. 完全なコードサンプルを client_secret.json ファイルと同じディレクトリのローカル ファイルにコピーします(または、ファイルの場所を正しく識別するようにサンプルを変更します。

  4. コマンドラインからサンプルを実行します。

    php sample.php
  5. ほとんどのサンプルでは、STDOUT に出力します。ウェブ アプリケーションの場合、表示しているウェブページに出力します。また、YouTube のウェブサイトでは、プレイリストやチャンネル セクションの作成リクエストなど、データの書き込みをリクエストする影響を確認することもできます。

Ruby

前提条件

  • Ruby 2.0 以上
  • Ruby 用 Google API クライアント ライブラリ:
    gem install google-api-client

プロジェクトを設定してコードサンプルを実行する

  1. API Console でプロジェクトを作成し、Google API Console で OAuth 2.0 の認証情報を設定します。認証情報を設定する際に、アプリケーションの種類を [その他] に設定します。

  2. 認証情報に関連付けられている client_secret.json ファイルをローカル ファイルに保存します。

  3. 完全なコードサンプルを client_secret.json ファイルと同じディレクトリのローカル ファイルにコピーします(または、ファイルの場所を正しく識別するようにサンプルを変更します。

  4. コマンドラインからサンプルを実行します。

    ruby sample.rb
  5. ほとんどのサンプルでは、STDOUT に出力します。ウェブ アプリケーションの場合、表示しているウェブページに出力します。また、YouTube のウェブサイトでは、プレイリストやチャンネル セクションの作成リクエストなど、データの書き込みをリクエストする影響を確認することもできます。

[Go]
  1. API Console でプロジェクトを作成し、Google API Console で OAuth 2.0 の認証情報を設定します。認証情報を設定する際に、アプリケーションの種類を [その他] に設定します。

  2. 認証情報に関連付けられている client_secret.json ファイルをローカル ファイルに保存します。

  3. 完全なコードサンプルを client_secret.json ファイルと同じディレクトリのローカル ファイルにコピーします(または、ファイルの場所を正しく識別するようにサンプルを変更します。

  4. コマンドラインからサンプルを実行します。

    go run sample.go
  5. ほとんどのサンプルでは、STDOUT に出力します。ウェブ アプリケーションの場合、表示しているウェブページに出力します。また、YouTube のウェブサイトでは、プレイリストやチャンネル セクションの作成リクエストなど、データの書き込みをリクエストする影響を確認することもできます。

ボイラープレート関数を使用する

前述のように、完全なコードサンプルでは、API リクエストの承認と構築にボイラープレート コードを使用しています。たとえば、Python サンプルの build_resource 関数は、リソース プロパティをその値にマッピングする辞書を使用して、挿入や更新が可能なリソースを作成します。JavaScript、PHP、Ruby、Go、Apps Script にも同様の関数が用意されています。

たとえば、以下のタブは、リソースを構築するためのボイラープレート関数がどのように playlist リソースを構築するために呼び出されるかを示しています。ボイラープレート関数が、作成されるリソースのタイプを認識している必要はないことに注意してください。

JavaScript
function createResource(properties) {
  var resource = {};
  var normalizedProps = properties;
  for (var p in properties) {
    var value = properties[p];
    if (p && p.substr(-2, 2) == '[]') {
      var adjustedName = p.replace('[]', '');
      if (value) {
        normalizedProps[adjustedName] = value.split(',');
      }
      delete normalizedProps[p];
    }
  }
  for (var p in normalizedProps) {
    // Leave properties that don't have values out of inserted resource.
    if (normalizedProps.hasOwnProperty(p) && normalizedProps[p]) {
      var propArray = p.split('.');
      var ref = resource;
      for (var pa = 0; pa < propArray.length; pa++) {
        var key = propArray[pa];
        if (pa == propArray.length - 1) {
          ref[key] = normalizedProps[p];
        } else {
          ref = ref[key] = ref[key] || {};
        }
      }
    };
  }
  return resource;
}
var resource = createResource({
    'snippet.title': 'Sample playlist ',
    'snippet.description': 'This is a sample playlist description.',
    'snippet.tags[]': 'JavaScript code, interactive',
    'snippet.defaultLanguage': '',
    'status.privacyStatus': 'private'
}
Python
# Build a resource based on a list of properties given as key-value pairs.
# Leave properties with empty values out of the inserted resource.
def build_resource(properties):
  resource = {}
  for p in properties:
    # Given a key like "snippet.title", split into "snippet" and "title", where
    # "snippet" will be an object and "title" will be a property in that object.
    prop_array = p.split('.')
    ref = resource
    for pa in range(0, len(prop_array)):
      is_array = False
      key = prop_array[pa]
      # Convert a name like "snippet.tags[]" to snippet.tags, but handle
      # the value as an array.
      if key[-2:] == '[]':
        key = key[0:len(key)-2:]
        is_array = True
      if pa == (len(prop_array) - 1):
        # Leave properties without values out of inserted resource.
        if properties[p]:
          if is_array:
            ref[key] = properties[p].split(',')
          else:
            ref[key] = properties[p]
      elif key not in ref:
        # For example, the property is "snippet.title", but the resource does
        # not yet have a "snippet" object. Create the snippet object here.
        # Setting "ref = ref[key]" means that in the next time through the
        # "for pa in range ..." loop, we will be setting a property in the
        # resource's "snippet" object.
        ref[key] = {}
        ref = ref[key]
      else:
        # For example, the property is "snippet.description", and the resource
        # already has a "snippet" object.
        ref = ref[key]
  return resource

resource = build_resource({
    'snippet.title': 'Sample playlist ',
    'snippet.description': 'This is a sample playlist description.',
    'snippet.tags[]': 'Python code, interactive',
    'snippet.defaultLanguage': '',
    'status.privacyStatus': 'private'}
  
PHP
// Add a property to the resource.
function addPropertyToResource(&$ref, $property, $value) {
    $keys = explode(".", $property);
    $is_array = false;
    foreach ($keys as $key) {
        // Convert a name like "snippet.tags[]" to "snippet.tags" and
        // set a boolean variable to handle the value like an array.
        if (substr($key, -2) == "[]") {
            $key = substr($key, 0, -2);
            $is_array = true;
        }
        $ref = &$ref[$key];
    }

    // Set the property value. Make sure array values are handled properly.
    if ($is_array && $value) {
        $ref = $value;
        $ref = explode(",", $value);
    } elseif ($is_array) {
        $ref = array();
    } else {
        $ref = $value;
    }
}

// Build a resource based on a list of properties given as key-value pairs.
function createResource($properties) {
    $resource = array();
    foreach ($properties as $prop => $value) {
        if ($value) {
            addPropertyToResource($resource, $prop, $value);
        }
    }
    return $resource;
}

$propertyObject = createResource(array(
    'snippet.title' => 'Sample playlist ',
    'snippet.description' => 'This is a sample playlist description.',
    'snippet.tags[]' => 'Python code, interactive',
    'snippet.defaultLanguage' => '',
    'status.privacyStatus' => 'private'));
Ruby
# Build a resource based on a list of properties given as key-value pairs.
def create_resource(properties)
  resource = {}
  properties.each do |prop, value|
    ref = resource
    prop_array = prop.to_s.split(".")
    for p in 0..(prop_array.size - 1)
      is_array = false
      key = prop_array[p]
      if key[-2,2] == "[]"
        key = key[0...-2]
        is_array = true
      end
      if p == (prop_array.size - 1)
        if is_array
          if value == ""
            ref[key.to_sym] = []
          else
            ref[key.to_sym] = value.split(",")
          end
        elsif value != ""
          ref[key.to_sym] = value
        end
      elsif ref.include?(key.to_sym)
        ref = ref[key.to_sym]
      else
        ref[key.to_sym] = {}
        ref = ref[key.to_sym]
      end
    end
  end
  return resource
end

resource = create_resource({
    'snippet.title': 'Sample playlist ',
    'snippet.description': 'This is a sample playlist description.',
    'snippet.tags[]': 'Ruby code, interactive',
    'snippet.default_language': '',
    'status.privacy_status': 'private'})
Apps Script
// Build an object from an object containing properties as key-value pairs
function createResource(properties) {
  var res = {};
  var normalizedProps = {};
  for (var p in properties) {
    var value = properties[p];
    if (p.substr(-2, 2) == '[]' && value) {
      var adjustedName = p.replace('[]', '');
      normalizedProps[adjustedName] = value.split(',');
    } else {
      normalizedProps[p] = value;
    }
  }
  for (var p in normalizedProps) {
    if (normalizedProps.hasOwnProperty(p) && normalizedProps[p]) {
      var propArray = p.split('.');
      var ref = res;
      for (var pa = 0; pa < propArray.length; pa++) {
        var key = propArray[pa];
        if (pa == propArray.length - 1) {
          ref[key] = normalizedProps[p];
        } else {
          ref = ref[key] = ref[key] || {};
        }
      }
    };
  }
  return res;
}

var resource = createResource({
    'snippet.title': 'Sample playlist ',
    'snippet.description': 'This is a sample playlist description.',
    'snippet.tags[]': 'Apps Script code, interactive',
    'snippet.defaultLanguage': '',
    'status.privacyStatus': 'private'
});
Go
func addPropertyToResource(ref map[string]interface{}, keys []string, value string, count int) map[string]interface{} {
        for k := count; k < (len(keys) - 1); k++ {
                switch val := ref[keys[k]].(type) {
                case map[string]interface{}:
                        ref[keys[k]] = addPropertyToResource(val, keys, value, (k + 1))
                case nil:
                        next := make(map[string]interface{})
                        ref[keys[k]] = addPropertyToResource(next, keys, value, (k + 1))
                }
        }
        // Only include properties that have values.
        if (count == len(keys) - 1 && value != "") {
                valueKey := keys[len(keys)-1]
                if valueKey[len(valueKey)-2:] == "[]" {
                        ref[valueKey[0:len(valueKey)-2]] = strings.Split(value, ",")
                } else if len(valueKey) > 4 && valueKey[len(valueKey)-4:] == "|int" {
                        ref[valueKey[0:len(valueKey)-4]], _ = strconv.Atoi(value)
                } else if value == "true" {
                        ref[valueKey] = true
                } else if value == "false" {
                        ref[valueKey] = false
                } else {
                        ref[valueKey] = value
                }
        }
        return ref
}

func createResource(properties map[string]string) string {
        resource := make(map[string]interface{})
        for key, value := range properties {
                keys := strings.Split(key, ".")
                ref := addPropertyToResource(resource, keys, value, 0)
                resource = ref
        }
        propJson, err := json.Marshal(resource)
        if err != nil {
               log.Fatal("cannot encode to JSON ", err)
        }
        return string(propJson)
}

func main() {
        properties := (map[string]string{
                 "snippet.title": "Sample playlist ",
                 "snippet.description": "This is a sample playlist description.",
                 "snippet.tags[]": "Go code, interactive",
                 "snippet.defaultLanguage": "",
                 "status.privacyStatus": "private",
        })
        res := createResource(properties)

既存のリソースを読み込む

既存のリソースを更新するリクエストをテストするには、そのリソースの現在のプロパティ値を更新フォームに読み込みます。たとえば、動画に関するメタデータを更新するには、id プロパティ フィールドに動画 ID を入力し、[Load resource] ボタンをクリックします。現在のプロパティ値がフォームに読み込まれ、変更する値のみを更新できます。