開発環境に対する Service Usage の設定

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

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

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

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

Service Usage API の有効化

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

  1. Google Cloud コンソールの [API ライブラリ] ページに移動します。
    [API ライブラリ] ページに移動
  2. サービスへのアクセスに使用する Google Cloud プロジェクトを選択します。
  3. [API ライブラリ] ページで、[有効にする] をクリックします。
  4. ユーザー アカウントに Service Usage 管理者ロールがあることを確認します。

curl によるテスト

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

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
    
  2. 環境変数 PROJECT_ID にプロジェクトの識別子を設定します。プロジェクト ID またはプロジェクト番号を指定できます。

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

    gcloud auth login
    
  4. このプロジェクトで有効な API とサービスが一覧表示されます。

    gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_ID}/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"
        }
      },
      ...
    

次のステップ

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