The Google APIs package exposes dozens of Google services that you can use from Dart projects.

Google APIs package 提供了许多你可以从 Dart 项目中使用的 Google 服务。

This page describes how to use APIs that interact with end-user data by using Google authentication.

本页面描述了如何通过 Google 身份验证，使用这些 API 和终端用户数据交互。

Examples of user-data APIs include Calendar, Gmail, YouTube, and Firebase.

用户数据 API 的例子包括 Calendar、Gmail、YouTube 和 Firebase。

:::note

The only APIs you should use directly from your Flutter project are those that access user data using Google authentication.

你只应该在 Flutter 项目中使用那些已经通过了 Google 身份验证的用户数据 API。

APIs that require service accounts should not be used directly from a Flutter application. Doing so requires shipping service credentials as part of your application, which is not secure. To use these APIs, we recommend creating an intermediate service.

那些需要 服务账号 的 API， 不应该 直接使用到 Flutter 应用中。 直接使用需要将服务证书作为应用程序的一部分，这是不安全的。 我们推荐创建一个中间服务，来使用这些 API。

:::

To add authentication to Firebase explicitly, check out the Add a user authentication flow to a Flutter app using FirebaseUI codelab and the Get Started with Firebase Authentication on Flutter docs.

To use Google APIs, follow these steps:

请遵循以下步骤使用 Google API：

1. Pick the desired API

   选择所需的 API

2. Enable the API

   启用 API 服务

3. Authenticate user with the required scopes

   使用所需的作用域对用户进行身份验证

4. Obtain an authenticated HTTP client

   获取身份验证后的 HTTP 客户端

5. Create and use the desired API class

   创建并使用所需的 API 类

The documentation for package:googleapis lists each API as a separate Dart library&emdash;in a name_version format. Check out youtube_v3 as an example.

文档 package:googleapis 采用 name_version 的形式， 列举了每一个可以单独作为 Dart 库的 API。 一起看看 youtube_v3 这个例子。

Each library might provide many types, but there is one root class that ends in Api. For YouTube, it's YouTubeApi.

每个库都可能提供多种类型，但是一定会有一个以 Api 结尾的 根 类。 在 YouTube 中，根类就是 YouTubeApi。

Not only is the Api class the one you need to instantiate (see step 3), but it also exposes the scopes that represent the permissions needed to use the API. For example, the Constants section of the YouTubeApi class lists the available scopes. To request access to read (but not write) an end-users YouTube data, authenticate the user with youtubeReadonlyScope.

Api 类不仅是你需要初始化的类（详见步骤 3）， 它还暴露了使用该 API 所需权限的作用域。 例如， YouTubeApi 类中 常量 这一节， 你会看到可用的作用域有哪些。 为了获取终端用户的 YouTube 数据的读取（并非写入）权限， 请使用 youtubeReadonlyScope 对用户进行验证。

/// Provides the `YouTubeApi` class.
import 'package:googleapis/youtube/v3.dart';

To use Google APIs you must have a Google account and a Google project. You also need to enable your desired API.

使用 Google API，你必须有一个 Google 账户和一个 Google 项目。你还需要启用所需的 API 服务。

This example enables YouTube Data API v3.

在本示例中，你将需要启用 YouTube Data API v3 服务。

For details, see the getting started instructions.

详情请看 入门指南。

Use the google_sign_in package to authenticate users with their Google identity. Configure signin for each platform you want to support.

使用 google_sign_in package 对用户进行 Google 身份验证。 为你需要的平台配置登录。

/// Provides the `GoogleSignIn` class
import 'package:google_sign_in/google_sign_in.dart';

When instantiating the GoogleSignIn class, provide the desired scopes as discussed in the previous section.

当你初始化 GoogleSignIn 类时， 你需要提供前面的小节中提到的所需的作用域。

final _googleSignIn = GoogleSignIn(
  scopes: <String>[YouTubeApi.youtubeReadonlyScope],
);

Follow the instructions provided by package:google_sign_in to allow a user to authenticate.

按照 package:google_sign_in 中的介绍来进行用户验证。

Once authenticated, you must obtain an authenticated HTTP client.

一旦验证完毕，你必须获取一个验证后的 HTTP 客户端。

The extension_google_sign_in_as_googleapis_auth package provides an extension method on GoogleSignIn called authenticatedClient.

extension_google_sign_in_as_googleapis_auth package 在 GoogleSignIn 中提供了一个 扩展方法： authenticatedClient。

import 'package:extension_google_sign_in_as_googleapis_auth/extension_google_sign_in_as_googleapis_auth.dart';

Add a listener to onCurrentUserChanged and when the event value isn't null, you can create an authenticated client.

你可以监听 onCurrentUserChanged。 当事件值不是 null 时，你可以创建一个身份验证后的客户端。

var httpClient = (await _googleSignIn.authenticatedClient())!;

This Client instance includes the necessary credentials when invoking Google API classes.

Client 实例 包含了调用 Google API 类时所需的凭证。

Use the API to create the desired API type and call methods. For instance:

使用 API 来创建所需的 API 类型和调用方法，例如：

var youTubeApi = YouTubeApi(httpClient);

var favorites = await youTubeApi.playlistItems.list(
  ['snippet'],
  playlistId: 'LL', // Liked List
);

You might want to check out the following:

你可能还需要了解以下内容：

• The extension_google_sign_in_as_googleapis_auth example is a working implementation of the concepts described on this page.

  示例 extension_google_sign_in_as_googleapis_auth 是本页面所述概念的一个可行的实现。