CSS API 使用入门

以下是 CSS API 的使用方法:

权限

如需使用 CSS API,您需要在两个位置配置权限:Google Cloud 和 CSS 中心。

  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 上的提交新问题按钮。

在完成每项任务后,如需提供一般性反馈,请使用反馈表单