はじめに

このページでは、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 ライブラリ] ページで、[有効にする] をクリックします。

サービス アカウントを作成

このセクションでは、curl コマンドを実行するためのサービス アカウントとキーを作成します。

  1. Cloud Console の [サービス アカウント]ページに移動します。
    サービス アカウント ページに移動
  2. [選択] をクリックして、サービスへのアクセスに使用する Cloud プロジェクトを選択します。
  3. サービス アカウントを作成します。サービス アカウントの作成方法については、サービス アカウントの作成と管理を参照してください。 このセクションの手順を実行するには、サービスアカウントにroles/serviceusage.serviceUsageAdminのロールを付与する必要があります。サービス アカウントにロールを付与する方法については、サービス アカウントへのロールの付与をご覧ください。
  4. Cloud Console のAPI 認証情報ページに移動します。
    API 認証情報ページに移動
  5. 新しいサービス アカウント用にサービス アカウント キーを作成し、その JSON 認証情報ファイルをローカルマシンにダウンロードします。このガイドの例では、ファイルパスが ~/credentials.json であると想定しています。サービス アカウント キーの作成方法については、サービス アカウント キーの作成と管理をご覧ください。
  6. ローカルマシンに oauth2l をインストールし、Google OAuth システムを操作できるようにします。

curl によるテスト

  1. まず、初期設定を確認します。

    oauth2l header --json ~/credentials.json cloud-platform
    
  2. OAuth フローを終えると、次のような出力が表示されます。

    Authorization: Bearer y29.xxxxxxx
    
  3. Google REST API の呼び出しに便利なシェル エイリアスを定義します。

    alias gcurl='curl -H "$(oauth2l header --json ~/credentials.json cloud-platform userinfo.email)" -H "Content-Type: application/json"'
    
  4. プロジェクトで利用可能で有効な API とサービスを一覧表示してみます。

    gcurl https://serviceusage.googleapis.com/v1/projects/357084163378/services
    

    サービスのリストが表示されれば設定は成功です。

次のステップ

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