Google Cloud Search API へのアクセスを構成する

この API を直接使用したり、SDK を介して使用したりするには、事前に Google Cloud Search API へのアクセスを構成する必要があります。このドキュメントでは、Cloud Search API REST API に必要な手順について説明します。

1. API プロジェクトを作成する

API を有効にするには、まず Google Cloud プロジェクトを作成します。このプロジェクトは、Google Cloud サービスの使用、API の管理、権限の設定の基盤となります。

  1. Google Cloud コンソールを開きます。
  2. [Google Cloud コンソール] の右側にあるプロジェクトのプルダウンをクリックし、[新しいプロジェクト] を選択します。
  3. [プロジェクト名] フィールドに名前を入力します。
  4. (省略可)[編集] をクリックしてプロジェクト ID を変更します。この ID は作成後に変更できません。
  5. [参照] をクリックして場所を選択し、[選択] をクリックします。
  6. [作成] をクリックします。通常、プロジェクトは数分で準備が完了します。

詳細については、プロジェクトの作成と管理をご覧ください。

2. API を有効にする

Cloud Search API を有効にし、サービス アカウントを作成して認証情報を取得します。

  1. Google Cloud コンソールのバナーにあるプルダウン メニューから新しいプロジェクトを選択します。
  2. [API とサービスを有効化] をクリックします。
  3. Google Cloud Search API を検索して選択します。
  4. [有効にする] をクリックします。

詳細については、Google Cloud コンソールで API を管理するをご覧ください。

3. サービス アカウントの認証情報を作成する

  1. Google Cloud コンソールで、左側のナビゲーションにある [認証情報] をクリックします。
  2. [認証情報を作成] プルダウン メニューから [サービス アカウント] を選択します。
  3. [サービス アカウント名] フィールドに名前を入力します。
  4. (省略可)サービス アカウント ID を編集します。
  5. [作成して続行] をクリックします。
  6. [完了] をクリックして、[サービス アカウント] リストに移動します。
  7. 新しいサービス アカウントのメールアドレスをクリックし、[キー] タブを選択します。
  8. [鍵を追加] > [新しい鍵を作成] の順にクリックします。
  9. [JSON] を選択し、[作成] をクリックします。秘密鍵がパソコンにダウンロードされます。

詳しくは、サービス アカウントをご覧ください。

4. サービス アカウントのメールアドレスを特定する

  1. Google Cloud コンソールで、プロジェクトを選択します。
  2. ナビゲーション メニュー > [IAM と管理] > [サービス アカウント] をクリックします。
  3. サービス アカウントのメールアドレスをメモします。これは、Cloud Search にデータソースを追加するために必要です。

5. サードパーティのサポートを初期化する

他の Cloud Search API を呼び出す前に、Google Cloud Search のサードパーティ サポートを初期化します。

サードパーティのサポートを初期化するには:

  1. Cloud Search プラットフォーム プロジェクトでウェブ アプリケーションの認証情報を作成します。認証情報を作成するをご覧ください。クライアント ID とクライアント シークレットが必要です。
  2. OAuth 2.0 Playground を使用してアクセス トークンを取得します。
    1. [OAuth 2.0 Configuration](設定アイコン)をクリックし、[Use your own OAuth credentials] をオンにします。
    2. クライアント ID とクライアント シークレットを入力します。
    3. スコープ フィールドに「https://www.googleapis.com/auth/cloud_search.settings」と入力し、[API を承認] をクリックします。
    4. [Exchange authorization code for tokens] をクリックします。
  3. 次の curl コマンドを実行します。[YOUR_ACCESS_TOKEN] は実際のトークンに置き換えます。

    curl --request POST \
    'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{}' \
      --compressed
    

    成功した場合、レスポンスの本文には operation が含まれます。失敗した場合は、Cloud Search サポートにお問い合わせください。

  4. operations.get を使用して初期化を検証します。

    curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
    --header 'Accept: application/json' \
    --compressed
    

    donetrue の場合、初期化は完了しています。

次のステップ

  1. Google Cloud Search を Microsoft® SharePoint® などの Google 以外のリポジトリとともに使用する場合は、データソースを作成する必要があります。検索対象のデータソースを追加するをご覧ください。
  2. データソースを設定したら、スキーマを作成して登録し、Cloud Search がデータをどのように表現するかを指定します。