はじめに

このページでは、Service Usage API を使用するための開発環境を設定する方法について説明します。

  • ほとんどのオペレーションのユースケースで、サービスを有効または無効にするには、Google Cloud Console を使用するのが最も簡単な方法です。
  • スクリプトを作成する必要がある場合は、gcloud コマンドライン ツールを使用できます。
  • Service Usage API を使ったプログラミングを行う必要がある場合は、クライアントライブラリのいずれかを使用してください。
  • API を試してみるには、このガイドの代替セットアップ手順に従い、curl コマンドを使用して、完全なアプリケーション開発環境を整えることなく、API をテストできます。

API を直接呼び出すためのセットアップ

このセクションでは、curlコマンドを使用して Service Usage API を試すためのローカル環境を設定するために必要な基本的な手順について説明します。これは、Service Usage API に対してプログラミングを行う必要のあるデベロッパーを対象にしています。

Service Usage API の有効化

Service Usage API を使用するには、まず、使用予定の Cloud プロジェクトで API を有効にする必要があります。

  1. Google Cloud Console の [API ライブラリ] ページに移動します。
    [API ライブラリ] ページに移動
  2. サービスへのアクセスに使用する Cloud プロジェクトを選択します。
  3. [API ライブラリ] ページで、[有効にする] をクリックします。

承認を構成する

Service Usage API が Cloud プロジェクトにアクセスすることを承認する手順は次のとおりです。

  1. サービス アカウントを作成します。
    1. Cloud Console の [サービス アカウント]ページに移動します。
      [サービス アカウント] ページに移動
    2. サービスへのアクセスに使用する Cloud プロジェクトを選択します。
    3. サービス アカウントを作成します。サービス アカウントの作成方法については、サービス アカウントの作成と管理を参照してください。
  2. 新しいサービス アカウントにService Usage 管理者のロールを付与します。サービス アカウントにロールを付与する方法については、サービス アカウントへのロールの付与をご覧ください。
  3. ローカルマシンを構成します。

    1. Cloud Console の [API 認証情報] ページに移動します。
      [API 認証情報] ページに移動
    2. 新しいサービス アカウント用にサービス アカウント キーを作成し、その JSON 認証情報ファイルをローカルマシンにダウンロードします。このガイドの例では、ファイルパスが ~/credentials.json であると想定しています。サービス アカウント キーの作成方法については、サービス アカウント キーの作成と管理をご覧ください。
    3. ローカルマシンに oauth2l をインストールし、Google OAuth システムを操作できるようにします。
    4. 必要に応じて、oauth2l を使用して、認証情報ファイルを使用した署名なしトークンを作成します。これにより、OAuth 設定が正しいこと、サービス アカウント認証情報ファイルが有効であることを確認できます。

          oauth2l header --json ~/credentials.json cloud-platform userinfo.email
      

      成功すると、出力は次のようになります。

          Authorization: Bearer y29.xxxxxxx
      

curl によるテスト

  1. Google REST API の呼び出しに便利なシェル エイリアスを定義します。

    alias gcurl='curl -H "$(oauth2l header --json ~/credentials.json cloud-platform userinfo.email)" -H "Content-Type: application/json"'
    
  2. 環境変数 PROJECT_ID にプロジェクトの識別子を設定します。

    PROJECT_ID="my-project-id"
    
  3. 「gcloud」にログインしていることを確認します。

    gcloud auth login
    
  4. gcloud を使用してプロジェクトのプロジェクト番号を見つけ、環境変数に保存します。

    PROJECT_NUMBER=`gcloud projects list --filter="${PROJECT_ID}" --format="value(PROJECT_NUMBER)"`
    
  5. このプロジェクトで有効な API とサービスが一覧表示されます。

    gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_NUMBER}/services?filter=state:ENABLED&fields=services.config.title,services.config.name"
    

    次のような出力が表示された場合、設定は成功しています。

    {
    "services": [
      {
        "config": {
          "name": "bigquery.googleapis.com",
          "title": "BigQuery API"
        }
      },
      {
        "config": {
          "name": "bigquerystorage.googleapis.com",
          "title": "BigQuery Storage API"
        }
      },
      ...
    

次のステップ

サービスの一覧表示に従って、Cloud プロジェクトで有効になっているか利用可能な API とサービスを一覧表示します。