設定 Google Cloud Search API 存取權

您必須先設定 Google Cloud Search API 的存取權,才能直接使用這個 API,或透過 SDK。本文說明使用 Google Cloud Search API REST API 的必要步驟。

1. 建立 API 專案

如要啟用 API,您必須先建立 Google Cloud 專案。這項專案是建立、啟用和使用所有 Google Cloud 服務的基礎,包括管理 API、啟用計費功能、新增及移除協作者,以及管理權限。

  1. 開啟 Google Cloud 控制台

  2. 在頁面頂端,按一下「Google Cloud Console」右側的 。隨即會顯示列出目前專案的對話方塊。

  3. 按一下「新增專案」。「New Project」(新增專案) 畫面隨即顯示。

  4. 在「Project Name」欄位中輸入專案名稱。

  5. (選用) 按一下「Edit」來編輯專案 ID。專案 ID 建立後就無法變更,因此請選用符合專案整個生命週期需求的 ID。

  6. 如要瀏覽專案位置,請按一下「瀏覽」

  7. 按一下專案位置,然後按一下「選取」

  8. 按一下「建立」,主控台會前往「資訊主頁」頁面。專案會在幾分鐘內建立。

如要進一步瞭解如何建立及管理專案,請參閱建立及管理專案

2. 啟用 API

您必須啟用 Google Cloud Search API 並建立服務帳戶,才能取得憑證。

  1. 為確保您使用的是新建立的專案,請按一下 Google Cloud 控制台橫幅右側的 圖示,然後選取新建立的專案。
  2. 按一下「啟用 API 和服務」。系統隨即會顯示「歡迎使用 API 程式庫」頁面。
  3. 前往 Google Cloud Search API
  4. 點選「Enable」(啟用)。「總覽」頁面隨即顯示。

如要進一步瞭解如何啟用及停用 API,請參閱在 Google Cloud 控制台中管理 API

3. 建立服務帳戶憑證

  1. Google Cloud 控制台的左側導覽面板中,按一下「Credentials」(憑證)。「憑證」頁面會隨即顯示。
  2. 在「Create credentials」(建立憑證) 下拉式清單中,選取 [Service account] (服務帳戶)。隨即顯示「建立服務帳戶」頁面。
  3. 在「Service account name」(服務帳戶名稱) 欄位中輸入名稱。
  4. (選用) 編輯服務帳戶 ID。
  5. 按一下「建立」,「服務帳戶權限」畫面隨即顯示。
  6. 按一下「Continue」(繼續)。系統隨即會顯示「將存取權授予使用者這個服務帳戶」畫面。
  7. 按一下「建立金鑰」,然後點選「完成」。系統隨即會顯示「已儲存到電腦的私密金鑰」對話方塊,並將私密金鑰的副本下載至電腦。
  8. 點選「關閉」

如要進一步瞭解服務帳戶,請參閱服務帳戶、網頁應用程式和已安裝的應用程式一文。

4. 確定電子郵件地址

  1. Google Cloud 控制台,選取在頁面頂端建立的專案。
  2. 按一下 Google Cloud 控制台橫幅左側的導覽選單。
  3. 依序點選「IAM 與管理」 >「服務帳戶」
  4. 在清單中「Service account ID」(服務帳戶 ID) 底下,記下系統產生的電子郵件地址,用來識別您設定的服務帳戶。將資料來源新增至 Cloud Search 時,會使用這個電子郵件地址。

5. 初始化第三方支援

您必須先初始化 Google Cloud Search 的第三方支援,才能呼叫任何其他 Cloud Search API。

如何初始化 Cloud Search 的第三方支援:

  1. 您的 Cloud Search 平台專案含有服務帳戶憑證。不過,為了初始化第三方支援,您必須建立網頁應用程式憑證。如需建立網頁應用程式憑證的操作說明,請參閱建立憑證。完成這個步驟後,您應該擁有用戶端 ID 和用戶端密鑰檔案。

  2. 使用 Google 的 OAuth 2 Playground 取得存取權杖:

    1. 按一下「設定」,然後勾選「使用您自己的驗證憑證」
    2. 輸入步驟 1 的用戶端 ID 和用戶端密鑰。
    3. 點選「關閉」
    4. 在範圍欄位中輸入 https://www.googleapis.com/auth/cloud_search.settings,然後按一下「Authorize」(授權)。OAuth 2 Playground 會傳回授權碼。
    5. 按一下「Exchange License code for token」。傳回權杖。
  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
    

    第三方初始化完成後,會包含設為 truedone 欄位。例如:

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

後續步驟

以下是你可以採取的後續步驟:

  1. 如果您打算將 Google Cloud Search 與非 Google 資料存放區 (例如 Microsoft® SharePoint®) 搭配使用,則必須建立資料來源。如要瞭解如何新增資料來源,請參閱「在搜尋中新增資料來源」。

  2. 設定好資料來源後,您可以建立及註冊結構定義,藉此瞭解 Google Cloud Search 應如何呈現存放區中的資料。