設定 Google Cloud Search API 存取權

必須先設定 Google Cloud Search API 的存取權,才能 直接或透過 SDK 使用這個 API這份文件 介紹了使用 Google Cloud Search API REST API 的必要步驟。

1. 建立 API 專案

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

  1. 開啟 Google Cloud 控制台

  2. 按一下頁面頂端的 。列出目前專案的對話方塊 出現。

  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 控制台, 按一下左側導覽列中的「憑證」。「憑證」頁面會隨即顯示。
  2. 在「Create credentials」(建立憑證) 下拉式清單中選取 服務帳戶。 「建立服務帳戶」出現。
  3. 在「Service account name」(服務帳戶名稱) 欄位中輸入名稱。
  4. (選用) 編輯服務帳戶 ID。
  5. 按一下「建立」,「服務帳戶權限」畫面上會顯示提示訊息。
  6. 按一下「Continue」(繼續)。「授予使用者這個服務帳戶的存取權」螢幕 出現。
  7. 按一下「建立金鑰」,然後點選「完成」。「私密金鑰已儲存到您的 電腦」對話方塊中,然後將私密金鑰的副本下載至您的 電腦。
  8. 按一下「關閉」

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

4. 確定電子郵件地址

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

5. 初始化第三方支援

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

如何初始化 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 然後按一下「授權」。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
    

    第三方初始化完成後,其中包含 「done」欄位已設為 true。例如:

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

後續步驟

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

  1. 如果您打算透過非 Google 資料存放區使用 Google Cloud Search, 例如 Microsoft® SharePoint® 必須建立資料來源如需 新增資料來源,請參閱 在 Cloud Search 中新增資料來源

  2. 設定資料來源後 建立並註冊結構定義 Google Cloud Search 應以何種方式呈現存放區中的資料