使用入门

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

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

创建 Google 帐号

要在应用中使用 Google Cloud API,您首先需要拥有一个 Google 帐号。这让您可以使用 Google 开发者产品,包括 Google Cloud ConsoleCloud SDKCloud LoggingCloud Monitoring。如果您是 Google Cloud 新手,请创建一个帐号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。

创建 Google 项目

要使用 Cloud API,您还需要拥有一个 Google 项目。一个项目等效于一个开发者帐号。它充当您的 Google Cloud 资源的资源容器。它还为使用 Google Cloud 服务提供了一个隔离边界,从而使您可以在项目级层独立管理配额限制和结算。使用的遥测和信息中心也按项目分组。如果您还没有项目,则可以使用 Cloud Console 进行创建。

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

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

启用 API

您必须为项目启用 Cloud API,然后才能使用该 API。根据您的应用所涉及的服务和项目,包括客户端项目和资源项目,您可能需要为多个项目启用 API。

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

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

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

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

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

正在启用结算功能

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

如果您没有结算帐号,请转到 Cloud Console 结算页面并按照说明创建一个帐号。然后将您的结算帐号关联到您的项目。

获取应用凭据

Cloud API 仅接受来自注册应用的 API 请求。此要求可帮助 API 提供方将 API 使用情况关联到拥有该应用的正确项目并报告 API 使用情况。

Cloud API 使用应用凭据来识别调用应用。凭据类型包括 API 密钥、OAuth 2.0 客户端和服务帐号。您可以使用 Cloud Console 创建、检索和管理应用凭据。如需详细了解应用凭据,请参阅身份验证概览

使用应用凭据

如果您刚开始接触 Google Cloud API,我们强烈建议您先使用 oauth2l 来试用应用凭据和 Cloud API,再编写应用代码。oauth2l 可以接受任何应用凭据,并使用这些凭据通过 curl 命令来调用 Google Cloud API。

示例:

oauth2l curl --credentials ./creds.json --scope cloud-platform --url https://pubsub.googleapis.com/v1/projects/my-project-id/topics -- -v

构建应用

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

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

更多信息

如需详细了解身份验证,请参阅身份验证概览

如需详细了解错误处理,请参阅处理错误

如需了解结算的详细信息,请参阅创建、修改或关闭结算帐户

如需详细了解如何为项目启用结算功能,请参阅修改项目的结算设置

如需详细了解如何启用和停用 API,请参阅启用和停用服务