この API を直接使用するか、SDK を介して使用するには、事前に Google Cloud Search API へのアクセスを構成する必要があります。このドキュメントでは、Google Cloud Search API REST API を使用するために必要な手順について説明します。
1. API プロジェクトを作成する
API を有効にするには、まず Google Cloud プロジェクトを作成する必要があります。このプロジェクトは、API の管理、請求の有効化、共同編集者の追加と削除、権限の管理など、すべての Google Cloud サービスの作成、有効化、使用の基礎となります。
Google Cloud コンソールを開きます。
ページの上部にある [Google Cloud コンソール] の右側にある
をクリックします。現在のプロジェクトをリストしたダイアログが表示されます。[新しいプロジェクト] をクリックします。[New Project] 画面が表示されます。
[プロジェクト名] フィールドにプロジェクト名を入力します。
(省略可)[編集] をクリックしてプロジェクト ID を編集します。プロジェクトが作成された後にプロジェクト ID を変更することはできないため、プロジェクトのライフタイムを考慮してニーズに合った ID を指定してください。
プロジェクトの場所を参照するには、[参照] をクリックします。
プロジェクトのロケーションをクリックし、[選択] をクリックします。
[作成] をクリックします。コンソールが [ダッシュボード] ページに移動します。プロジェクトは数分で作成されます。
プロジェクトの作成と管理の詳細については、プロジェクトの作成と管理をご覧ください。
2. API を有効にする
Google Cloud Search API を有効にし、サービス アカウントを作成して認証情報を取得する必要があります。
- 新たに作成したプロジェクトを対象とするために、Google Cloud コンソール バナーの右側にある アイコンをクリックし、新たに作成したプロジェクトを選択します。
- [API とサービスの有効化] をクリックします。[API ライブラリへようこそ] ページが表示されます。
- Google Cloud Search API に移動します。
- [有効にする] をクリックします。[概要] ページが表示されます。
API の有効化と無効化の詳細については、Google Cloud コンソールで API を管理するをご覧ください。
3. サービス アカウントの認証情報を作成する
- Google Cloud コンソールで、左側のナビゲーションにある [認証情報] をクリックします。[認証情報] ページが表示されます。
- [認証情報を作成] プルダウン リストから [サービス アカウント] を選択します。[サービス アカウントの作成] ページが表示されます。
- [サービス アカウント名] フィールドに名前を入力します。
- (省略可)サービス アカウント ID を編集します。
- [作成] をクリックします。[サービス アカウントの権限] 画面が表示されます。
- [続行] をクリックします。[ユーザーにこのサービス アカウントへのアクセスを許可] 画面が表示されます。
- [キーを作成] をクリックし、[完了] をクリックします。[秘密鍵がパソコンに保存されました] ダイアログが表示され、秘密鍵のコピーがパソコンにダウンロードされます。
- [閉じる] をクリックします。
サービス アカウントの詳細については、サービス アカウント、ウェブ アプリケーション、インストール型アプリケーションをご覧ください。
4. メールアドレスを特定する
- Google Cloud コンソールで、ページの上部にある作成したプロジェクトを選択します。
- Google Cloud コンソール バナーの左側にあるナビゲーション メニューをクリックします。
- [IAM と管理] > [サービス アカウント] をクリックします。
- [サービス アカウント ID] のリストで、構成したサービス アカウントを識別する生成済みメールアドレスを書き留めます。このメールアドレスは、Cloud Search にデータソースを追加する際に使用されます。
5. サードパーティ サポートを初期化する
他の Cloud Search API を呼び出す前に、Google Cloud Search に対するサードパーティ サポートを初期化する必要があります。
Cloud Search のサードパーティ サポートを初期化するには:
Cloud Search Platform プロジェクトには、サービス アカウントの認証情報が含まれています。ただし、サードパーティ サポートを初期化するには、ウェブ アプリケーションの認証情報を作成する必要があります。ウェブ アプリケーションの認証情報を作成する手順については、認証情報を作成するをご覧ください。この手順が完了すると、クライアント ID とクライアント シークレット ファイルが作成されます。
Google の OAuth 2 Playground を使用してアクセス トークンを取得します。
- 設定をクリックし、[ユーザー独自の認証情報を使用] をオンにします。
- 手順 1 のクライアント ID とクライアント シークレットを入力します。
- [閉じる] をクリックします。
- scopes フィールドに「
https://www.googleapis.com/auth/cloud_search.settings
」と入力し、[承認] をクリックします。OAuth 2 Playground から認証コードが返されます。 - [Exchange authorization code for tokens] をクリックします。トークンが返されます。
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 サポートにお問い合わせください。
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 }
次のステップ
以下は、適宜実行してください。
Google Cloud Search を Google 以外のデータ リポジトリ(Microsoft® SharePoint® など)とともに使用する場合は、データソースを作成する必要があります。データソースの追加手順については、検索対象のデータソースを追加するをご覧ください。
データソースを設定すると、スキーマを作成および登録して、Google Cloud Search がリポジトリ内のデータをどのように表現するかを指定できます。