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

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

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

API を有効にするには、事前に Google Cloud Platform プロジェクトを作成する必要があります。このプロジェクトは、API の管理、請求の有効化、共同編集者の追加と削除、権限の管理など、すべての Google Cloud Platform(GCP)サービスの作成、有効化、使用の基礎となります。

  1. Google Cloud Console を開きます。

  2. ページの上部で、[Google Cloud Console] の右側にある をクリックします。 現在のプロジェクトをリストしたダイアログが表示されます。

  3. [新しいプロジェクト] をクリックします。[New Project] 画面が表示されます。

  4. [Project Name] フィールドにプロジェクト名を入力します。

  5. (省略可)[編集] をクリックしてプロジェクト ID を編集します。プロジェクトが作成された後にプロジェクト ID を変更することはできないため、プロジェクトのライフタイムを考慮してニーズに合った ID を指定してください。

  6. プロジェクトのロケーションを表示するには、[ブラウズ] をクリックします。

  7. プロジェクトの場所をクリックし、[選択] をクリックします。

  8. [作成] をクリックします。コンソールが [ダッシュボード] ページに移動します。プロジェクトは数分で作成されます。

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

2. API の有効化

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

  1. 新しく作成したプロジェクトが表示されていることを確認するには、Google Cloud Console バナーの右側にある アイコンをクリックし、新しく作成したプロジェクトを選択します。
  2. [API とサービスの有効化] をクリックします。[Welcome to API Library] ページが表示されます。
  3. Google Cloud Search API に移動します。
  4. [有効にする] をクリックします。[概要] ページが表示されます。

API の有効化と無効化の詳細については、Google Cloud Console で API を管理するをご覧ください。

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

  1. Cloud Platform Console で、左側のナビゲーションの [認証情報] をクリックします。[認証情報] ページが表示されます。
  2. [認証情報を作成] プルダウン リストから [サービス アカウント] を選択します。[サービス アカウントの作成] ページが表示されます。
  3. [サービス アカウント名] 項目に名前を入力します。
  4. (省略可)サービス アカウント ID を編集します。
  5. [作成] をクリックします。[サービス アカウントの権限] 画面が表示されます。
  6. [続行] をクリックします。[ユーザーにこのサービス アカウントへのアクセスを許可] 画面が表示されます。
  7. [キーを作成] をクリックし、[完了] をクリックします。[秘密鍵がパソコンに保存されました] ダイアログが表示され、秘密鍵のコピーがパソコンにダウンロードされます。
  8. [閉じる] をクリックします。

サービス アカウントの詳細については、サービス アカウント、ウェブ アプリケーション、インストール型アプリケーションをご覧ください。

4.メールアドレスを特定する

  1. Cloud Platform Console のページの上部で、作成済みのプロジェクトを選択します。
  2. Google Cloud Console バナーの左側にある [ナビゲーション] メニューをクリックします。
  3. [IAM と管理] > [サービス アカウント] をクリックします。
  4. リストの [サービス アカウント ID] で、構成したサービス アカウントを識別する生成済みメールアドレスをメモします。このメールアドレスは、Cloud Search にデータソースを追加する際に使用されます。

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

他の Cloud Search API を呼び出す前に、Google Cloud Search に対するサードパーティ サポートを初期化する必要があります。

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

  1. Cloud Search Platform プロジェクトにサービス アカウントの認証情報が含まれています。ただし、サードパーティのサポートを初期化するため、ウェブ アプリケーションの認証情報を作成する必要があります。ウェブ アプリケーションの認証情報を作成する方法については、認証情報を作成するをご覧ください。この手順を完了すると、クライアント ID とクライアント シークレット ファイルが作成されます。

  2. Google の OAuth 2 Playground を使用してアクセス トークンを取得します。

    1. [設定] をクリックし、[ユーザー独自の認証情報] チェックボックスをオンにします。
    2. 手順 1 のクライアント ID とクライアント シークレットを入力します。
    3. [閉じる] をクリックします。
    4. スコープ フィールドに「https://www.googleapis.com/auth/cloud_search.settings」と入力し、[承認] をクリックします。OAuth 2 Playground によって認証コードが返されます。
    5. [トークンの認証コードを交換] をクリックします。トークンが返されます。
  3. サードパーティによる Cloud Search のサポートを初期化するには、次の curl コマンドを使用します。[YOUR_ACCESS_TOKEN] は手順 2 で取得したトークンに置き換えてください。

    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 のインスタンスが含まれます。たとえば、以下の場合です。

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    }
    

    失敗した場合は、Cloud Search サポートにお問い合わせください。

  4. operations.get を使用して、サードパーティのサポートが初期化されていることを確認します。

    curl \
    'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
    [YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
    --header 'Accept: application/json' \
    --compressed
    

    サードパーティ初期化が完了すると、true に設定された done フィールドが含まれます。例:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    done: true
    }
    

次の手順

以下は、適宜実行してください。

  1. Google Cloud Search を Google 以外のデータ リポジトリ(Microsoft® SharePoint® など)とともに使用する場合は、データソースを作成する必要があります。データソースの追加手順については、検索対象のデータソースを追加するをご覧ください。

  2. データソースを設定すると、スキーマを作成および登録して、Google Cloud Search がリポジトリ内のデータをどのように表現するかを指定できます。