使用入门

本页面介绍开发者如何开始使用 Google Cloud API。

如果您是首次使用 Google Cloud API,可以按照本指南中的步骤,使用 curl 命令调用 API。您可以在开发应用之前,使用 curl 命令对 API 进行实验。

如果您是 Google Cloud新手,请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。

创建 Google 项目

如需使用 Google Cloud API,您需要拥有用户账号(Google 账号或外部身份提供商提供的账号)和Google 项目。一个项目等效于一个开发者账号。它充当 Google Cloud 资源的资源容器。它还为 Google Cloud 服务的使用提供了隔离边界,因此您可以在项目级别独立管理配额限制和结算。使用情况遥测和信息中心也按项目分组。如果您还没有项目,可以使用 Google Cloud 控制台创建一个。

一个项目可以拥有各种各样的资源,包括 API 密钥、OAuth 客户端、服务账号、Compute Engine 虚拟机、Cloud Storage 存储分区和 BigQuery 数据集。当应用调用 Google Cloud API 时,拥有应用凭证的项目称为客户端项目,而拥有目标资源的项目称为资源项目。如果 API 请求涉及多个资源,则会涉及多个资源项目。

如果您因任何原因想要停止使用 Google Cloud ,则可以使用 Google Cloud 控制台删除您的项目。在经过保留期限之后,您的项目和项目中的所有资源都将被删除。请注意,不同类型的数据的保留期限有所不同。

发现 API

在使用任何 Google Cloud API 之前,您应该使用 Google Cloud 控制台 API 库浏览可用的Google Cloud API,并发现最符合您业务需求的 API。

启用 API

某些 Google Cloud API 默认处于启用状态。如需使用未默认启用的 Google CloudAPI,您必须为项目启用该 API。 根据您的应用所涉及的服务和项目(包括客户端项目和资源项目),您可能需要为多个项目启用 API。如果您启用的 API 依赖于其他 API,那么这些 API 也会同时启用。

启用 API 需要您接受 API 的服务条款和结算责任。您需要获得项目的 serviceusage.services.enable 权限才能启用 API。如需了解详情,请参阅 Service Usage 访问权限控制

此外,要启用的服务必须设为公开,否则服务所有者必须向用户授予专用服务的 servicemanagement.services.bind 权限。如需了解详情,请参阅 Service Management 访问权限控制

要使用 Console 为项目启用 API,请执行以下操作:

  1. 前往 Google Cloud 控制台 API 库
  2. 从项目列表中选择您要使用的项目。
  3. 在 API 库中,选择要启用的 API。如果您在查找 API 时需要帮助,请使用搜索字段和过滤器。
  4. 在 API 页面上,点击启用

如果您不再使用某项目的 API,则可以在同一页面上停用该 API,以避免滥用和意外结算费用。您还可以使用 gcloud CLIService Usage API 启用和停用 Cloud API:

gcloud services enable pubsub.googleapis.com
gcloud services disable pubsub.googleapis.com

启用结算功能

有些 Google API 会收取使用费。您需要为项目启用结算功能,才能在项目中开始使用这些 API。在项目中使用 API 产生的费用都将计入与该项目关联的结算账号。

如果您没有结算账号,请前往 Google Cloud 控制台结算页面,然后按照说明创建一个结算账号。然后将您的结算账号关联到您的项目。

向 API 进行身份验证

如何向 API 进行身份验证取决于您的开发环境以及 API 支持的身份验证方法。

设置应用默认凭据以便在各种环境中使用是最常见的方法,建议大多数应用采用此方法。如果 API 支持 API 密钥,则这是另一种选择。如果您的应用需要访问最终用户拥有的 Cloud 资源,您需要创建 OAuth 2.0 客户端 ID 并使用身份验证库

如需了解有关身份验证的一般信息,请参阅 Google 身份验证

构建应用

如果您要使用 Cloud API 构建应用,我们建议您使用Google Cloud 客户端库(如果有的话)。客户端库处理常见的 API 功能,以方便您进行身份验证、错误处理、重试和载荷验证。您需要在初始化期间将应用凭据传递给客户端库,以便客户端库可以代表您的应用调用Google Cloud API。

请参阅以下分步指南,了解如何使用一些热门 API 的客户端库:

如需了解详情,请参阅客户端库说明

更多信息