開始使用 CSS API

如何使用 CSS API:

權限

如要使用 CSS API,您需要在 Google Cloud 和 CSS Center 兩處設定權限。

  1. Google Cloud IAM:

    • Google Cloud 控制台中建立服務帳戶。按照與 Content API 類似的操作說明,建立並下載 JSON 憑證檔案。這個步驟會將服務帳戶驗證為有效的 Google Cloud 實體。
    • 如果您使用直接 REST 存取或 Google API 用戶端程式庫,也需要從 Google Cloud 控制台產生的 API 金鑰
  2. CSS Center:

    • 服務帳戶電子郵件地址 (例如: your-service-account-name@your-project-id.iam.gserviceaccount.com) 必須新增為 CSS Center 帳戶的管理員。 這個步驟會授權服務帳戶存取及管理 CSS 中心資料。
    • 您可以在 CSS 群組層級授予存取權 (存取所有網域),也可以授予特定 CSS 網域帳戶存取權。就 API 存取權而言,通常會在 CSS 群組層級授予存取權。
    • 如何新增服務帳戶:
      • 以管理員使用者身分登入 CSS Center。
      • 前往「帳戶存取權」(齒輪圖示 ⚙️ 下方)。
      • 按一下「+ 新增使用者」,然後輸入服務帳戶電子郵件地址。
      • 將存取層級設為「管理員」
    • 權限最多可能需要 30 分鐘才會生效。如果遇到權限錯誤,請稍後再試。

驗證範圍:

CSS API 的必要 OAuth 2.0 範圍為:

  • https://www.googleapis.com/auth/content

確認應用程式在驗證時要求這個範圍。

啟用 CSS API

如要使用 CSS API,請在 Google Cloud 專案中啟用此 API。 程式庫位於 https://console.cloud.google.com/apis/library/css.googleapis.com

開始程式設計

CSS API 提供程式碼範例用戶端程式庫,協助您開始使用。我們也提供最佳做法頁面。

傳送要求

請將要求傳送至下列格式的網址:

https://css.googleapis.com/{version}/{resource name}:{method}

其中 {resource name} 是呼叫作業影響的資源名稱。

舉例來說,以下說明如何使用 gRPC 刪除資源:

https://css.googleapis.com/v1/{resource name}:delete

以下說明如何使用 REST 刪除資源:

DELETE https://css.googleapis.com/v1/{resource name}

如要進一步瞭解特定服務,請參閱 CSS API 參考說明文件

使用 gRPC 或 REST

CSS API 支援 gRPCREST。以下是發出 CSS API 呼叫的兩種方式:

gRPC (建議) REST
  1. 以通訊協定緩衝區的形式建立要求主體。
  2. 使用 HTTP/2 將要求主體傳送至伺服器。
  3. 將回應反序列化為通訊協定緩衝區。
  4. 解讀結果。
  1. 以 JSON 物件形式建立要求主體。
  2. 使用 HTTP 1.1 將其傳送至伺服器。
  3. 將回應還原序列化為 JSON 物件。
  4. 解讀結果。

取得說明

如需支援,請與 Google 代表聯絡,或使用意見回饋表單回報任何問題。

如果遇到問題,可以透過下列方式提供更多意見回饋:

提供意見

如要提供意見,請提交下列其中一項:

  • API 功能:提交意見回饋表單
  • 說明文件:使用頁面內的「喜歡」和「不喜歡」評分按鈕,以及「提供意見」按鈕。
  • 範例和程式庫:使用 GitHub 上的「New issue」(新問題) 按鈕。

如要在完成每項工作後提供一般意見,請填寫意見表單