クイックスタート: Natural Language API の設定

このガイドでは、Natural Language の使用開始に必要な設定手順をすべて説明します。

Google Cloud Console について

Google Cloud Console は、Google Cloud プロダクトを使用するシステムのプロビジョニング、構成、管理、モニタリングに使用されるウェブ UI です。Google Cloud Console を使用して、Natural Language リソースの設定と管理を行います。

プロジェクトを作成する

Google Cloud が提供するサービスを使用するには、プロジェクトを作成する必要があります。

プロジェクトを使用して、すべての Google Cloud のリソースがまとめられます。プロジェクトは、次のコンポーネントから構成されます。

  • 共同編集者
  • 有効な API とその他のリソース
  • モニタリング ツール
  • 課金情報
  • 認証とアクセス制御

1 つのプロジェクトを作成できるほか、複数のプロジェクトを作成してリソース階層内で Google Cloud リソースを構成することもできます。プロジェクトの詳細については、Resource Manager ドキュメントをご覧ください。

Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

プロジェクト セレクタに移動

課金を有効にする

請求先アカウントは、特定のリソースセットに対する支払いをだれが行うかの定義に使用され、1 つ以上のプロジェクトにリンクできます。プロジェクトの利用料金は、リンクされた請求先アカウントに請求されます。ほとんどの場合、プロジェクトの作成時に請求情報を構成します。詳細については、お支払いとご請求に関するドキュメントをご覧ください。

Cloud プロジェクトに対して課金が有効になっていることを確認します。詳しくは、プロジェクトで課金が有効になっているかどうかを確認する方法をご覧ください。

API を有効にする

Cloud Natural Language API をプロジェクトで有効にする必要があります。API の有効化の詳細については、Service Usage のドキュメントをご覧ください。

Cloud Natural Language API を有効にします。

API を有効にする

認証を設定する

API を使用するクライアント アプリケーションはすべて、認証の対象であり、リクエストされるリソースへのアクセス権が付与されている必要があります。このセクションでは、認証の重要なコンセプトと設定手順について説明します。詳細については、Google Cloud 認証の概要をご覧ください。

サービス アカウントについて

認証には複数のオプションがありますが、認証とアクセス制御にサービス アカウントを使用することをおすすめします。サービス アカウントでは、エンドユーザーではなく、アプリケーションの資格情報が提供されます。サービス アカウントはプロジェクトで所有されます。1 つのプロジェクトに対して多数のサービス アカウントを作成できます。詳しくは、サービス アカウントをご覧ください。

ロールについて

Cloud Natural Language API へのアクセスにロールは必要ありません。認証済みのユーザーまたはアプリケーションは、権限に関係なく API を呼び出せます。

サービス アカウントキーについて

サービス アカウントは、1 つまたは複数の公開鍵と秘密鍵のペアに関連付けられます。新しい鍵ペアを作成すると、秘密鍵がダウンロードされます。秘密鍵は、API の呼び出し時に認証情報の生成に使用されます。秘密鍵のセキュリティと、キーのローテーションなどの他の管理操作は、ユーザーの責任になります。

サービス アカウントを作成し、秘密鍵ファイルをダウンロードする

サービス アカウントを作成します。

  1. Cloud Console で [サービス アカウントの作成] ページに移動します。

    [サービス アカウントの作成] に移動
  2. プロジェクトを選択します。
  3. [サービス アカウント名] フィールドに名前を入力します。Cloud Console は、この名前に基づいて [サービス アカウント ID] フィールドに入力します。

    [サービス アカウントの説明] フィールドに説明を入力します。例: Service account for quickstart

  4. [作成して続行] をクリックします。
  5. [完了] をクリックして、サービス アカウントの作成を完了します。

    ブラウザ ウィンドウは閉じないでください。次のステップでこれを使用します。

サービス アカウント キーを作成します。

  1. Cloud Console で、作成したサービス アカウントのメールアドレスをクリックします。
  2. [キー] をクリックします。
  3. [鍵を追加]、[新しい鍵を作成] の順にクリックします。
  4. [作成] をクリックします。JSON キーファイルがパソコンにダウンロードされます。
  5. [閉じる] をクリックします。

環境でサービス アカウント キー ファイルを使用する

環境変数 GOOGLE_APPLICATION_CREDENTIALS を設定して、アプリケーション コードに認証情報を指定します。この変数は、現在のシェル セッションにのみ適用されます。この変数を新しいシェル セッションに適用する場合は、シェル起動ファイル(~/.bashrc ファイルや ~/.profile ファイルなど)で変数を設定します。

Linux または macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。

例:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

PowerShell の場合:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

KEY_PATH をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。

例:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

コマンド プロンプトの場合:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

KEY_PATH をサービス アカウント キーが含まれる JSON ファイルのパスに置き換えます。

gcloud CLI をインストールして初期化する

Natural Language API を使用する場合は、gcloud CLI をインストールして初期化する必要があります。gcloud CLI は、Google Cloud でホストされるリソースとアプリケーションの管理に使用できるツールのセットです。これには gcloud CLI が含まれます。次のリンクで手順を説明します。

Google Cloud CLI をインストールして初期化します。

SDK と認証をテストする

前の手順で認証を設定した場合は、gcloud CLI を使用して認証環境をテストできます。次のコマンドを実行し、エラーが発生せず、認証情報が返されることを確認します。

gcloud auth application-default print-access-token

このコマンドは、Natural Language のコマンドライン REST サンプルのすべてで API 呼び出しの認証に使用されます。

Natural Language API クライアント ライブラリをインストールする

Natural Language API を呼び出すには、3 通りの方法があります。

クライアント ライブラリは複数のよく使われている言語で利用できます。クライアント ライブラリのインストールについては、Cloud Natural Language クライアント ライブラリをご覧ください。