ご利用方法

このページでは、Google Cloud API の使用を開始する方法について説明します。

Google Cloud APIs を初めて使用する場合、このガイドの指示に沿って curl コマンドを使用して API を呼び出せます。curl コマンドを使用することで、アプリケーションを開発する前に API を試すことができます。

Google アカウントを作成する

Google Cloud API をアプリケーションで使用するには、まず Google アカウントが必要です。 これにより、Google Cloud ConsoleCloud SDKCloud LoggingCloud Monitoring などの Google のデベロッパー プロダクトを使用できるようになります。Google Cloud を初めて使用される方は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

Google プロジェクトの作成

Cloud API を使用するには、Google プロジェクトも必要です。プロジェクトはデベロッパー アカウントに相当します。これは、Google Cloud リソースのリソース コンテナとして機能します。また、Google Cloud サービスの使用に対して分離境界を提供するため、プロジェクト レベルで割り当て制限と課金を別々に管理できます。使用状況テレメトリーとダッシュボードもプロジェクトごとにグループ化されます。プロジェクトがない場合は、Cloud Console を使用して作成できます。

プロジェクトでは、API キー、OAuth クライアント、サービス アカウント、Compute Engine VM、Cloud Storage バケット、BigQuery データセットなど、幅広いリソースを所有できます。アプリケーションが Cloud API を呼び出すとき、アプリケーション認証情報を所有するプロジェクトは、クライアント プロジェクトと呼ばれ、ターゲット リソースを所有するプロジェクトはリソース プロジェクトと呼ばれます。1 つの API リクエストが複数のリソースにアクセスする場合、複数のリソース プロジェクトが含まれます。

なんらかの理由で Google Cloud の使用を停止する場合、Cloud Console を使用してプロジェクトを削除できます。プロジェクトとプロジェクト内のすべてのリソースは、保持期間の後に削除されます。データのタイプごとに保持期間が異なることに留意してください。

API の探索

Cloud APIs を使用する前に、Google Cloud Console の API ライブラリを使用して、使用可能な Cloud APIs を確認し、ビジネスニーズに最適な API を特定する必要があります。特定の Cloud API の詳細については、Spanner API などの一般公開ドキュメント サイトをご覧ください。

API を有効にしています

Cloud API を使用するには、プロジェクトでそれを有効にする必要があります。どのサービスやプロジェクトにどのプロジェクト(クライアント プロジェクトとリソース プロジェクトなど)が含まれるかに応じて、複数のプロジェクトで API を有効にする必要があります。

API を有効にするには、API の利用規約と請求の責任に同意する必要があります。API を有効にするには、プロジェクトに対する権限 serviceusage.services.enable が必要です。詳細については、Service Usage のアクセス制御をご覧ください。

コンソールを使用してプロジェクトの API を有効にするには、次の手順を行います。

  1. Cloud Console API ライブラリに移動します。
  2. プロジェクト リストから、使用するプロジェクトを選択します。
  3. API ライブラリで、有効にする API を選択します。API を検索する場合は検索フィールドやフィルタを使用します。
  4. [API] ページで、[有効にする] をクリックします。

同じページからプロジェクトの API を無効にすると、不正使用や誤課金を避けることができます。Cloud SDKService Usage API を使用して、Cloud APIs を有効または無効にすることもできます。

$ gcloud services enable pubsub.googleapis.com
$ gcloud services disable pubsub.googleapis.com

課金を有効にする

Cloud APIs の中には、使用量に応じて課金されるものがあります。そのような API は、プロジェクトで課金を有効にした後、使い始める必要があります。プロジェクトでの API 使用分は、プロジェクトに関連付けられた請求先アカウントに課金されます。

請求先アカウントがない場合は、Cloud Console の [お支払いとご請求] ページに移動し、指示に従って作成します。それから、プロジェクトに請求先アカウントをリンクします。

アプリケーションの認証情報の取得

Cloud API は、登録されたアプリケーションからの API リクエストのみを受け入れます。この要件により、API プロデューサーはアプリケーションを所有する適切なプロジェクトに関連付けて API の使用状況を報告できます。

Cloud API は、アプリケーションの認証情報を使用して呼び出し元アプリケーションを識別します。認証情報の種類には、API キー、OAuth 2.0 クライアント、サービス アカウントがあります。Cloud Console を使用して、アプリケーションの認証情報を作成、取得、管理できます。アプリケーションの認証情報の詳細については、認証の概要をご覧ください。

アプリケーションの認証情報の使用

Google Cloud APIs を初めて使用する場合は、アプリケーション コードを書き込む前に oauth2l を使用してアプリケーションの認証情報と Cloud APIs をテストすることを強くおすすめします。oauth2l では、アプリケーションの認証情報を受け入れ、curl コマンドを使用して Google Cloud APIs を呼び出すのに使用できます。

例:

oauth2l curl --credentials ./creds.json --scope cloud-platform --url https://pubsub.googleapis.com/v1/projects/my-project-id/topics -- -v

アプリケーションのビルド

Cloud API を使用してアプリケーションを構築する場合は、可能であれば Google Cloud クライアント ライブラリを使用することをおすすめします。クライアント ライブラリは、認証、エラー処理、再試行、ペイロード検証などの一般的な API 機能を処理します。初期化中にアプリケーションの認証情報をクライアント ライブラリに渡す必要があります。これにより、クライアント ライブラリでアプリケーションの代わりに Google Cloud API を呼び出すことが可能です。

詳しくはクライアント ライブラリの説明をご覧ください。

詳細

認証の詳細については、認証の概要をご覧ください。

エラー処理の詳細については、エラーの処理をご覧ください。

課金の詳細については、請求先アカウントの作成、変更、閉鎖をご覧ください。

プロジェクトの課金を有効化する方法については、プロジェクトの課金設定の変更をご覧ください。

API を有効化または無効化する方法については、サービスの有効化と無効化をご覧ください。