README

PHP 的 Google API 客户端库

参考文档: https://googleapis.github.io/google-api-php-client/master/
许可证: Apache 2.0

Google API 客户端库允许您在服务器上与 Google API（如 Gmail、Drive 或 YouTube）进行交互。

这些客户端库由 Google 官方支持。然而，这些库被视为完整且处于维护模式。这意味着我们将解决关键错误和安全问题，但不会添加任何新功能。

Google Cloud Platform

对于 Google Cloud Platform API，例如 Datastore、Cloud Storage、Pub/Sub 和 Compute Engine，我们建议使用 Google Cloud 客户端库。有关受支持的 Google Cloud 客户端库的完整列表，请参阅 googleapis/google-cloud-php。

要求

PHP 5.6.0 或更高版本

开发者文档

该 docs 文件夹提供了使用此库的详细指南。

安装

您可以使用 Composer 或直接 下载发布版本

Composer

首选方法是通过 composer。如果您尚未安装 composer，请遵循安装说明。

安装 composer 后，在项目根目录中执行以下命令以安装此库

composer require google/apiclient:^2.11

最后，请确保包含自动加载器

require_once '/path/to/your-project/vendor/autoload.php';

此库依赖于 google/apiclient-services。该库为大量 Google API 提供 API 包装器。为了使用户能够使用最新的 API 客户端，此库不针对 google/apiclient-services 的特定版本进行锁定。为了防止意外安装带有破坏性更改的 API 包装器，强烈建议在将此库用于生产之前，您自行将版本锁定为最新版本。

清理未使用的服务

有超过 200 个 Google API 服务。您可能不需要所有这些服务。为了避免将这些依赖项与您的代码一起打包，您可以运行 Google\Task\Composer::cleanup 任务，并在 composer.json 中指定要保留的服务。

{
    "require": {
        "google/apiclient": "^2.11"
    },
    "scripts": {
        "pre-autoload-dump": "Google\\Task\\Composer::cleanup"
    },
    "extra": {
        "google/apiclient-services": [
            "Drive",
            "YouTube"
        ]
    }
}

以下示例将在运行 composer update 或新的 composer install 时删除除 "Drive" 和 "YouTube" 之外的所有服务。

重要：如果您在 composer.json 中添加任何服务，您需要明确删除 vendor/google/apiclient-services 目录，以便更改生效。

rm -r vendor/google/apiclient-services
composer update

注意：此命令对服务名称进行精确匹配，因此为了保留 YouTubeReporting 和 YouTubeAnalytics，您需要明确添加每个服务。

{
    "extra": {
        "google/apiclient-services": [
            "Drive",
            "YouTube",
            "YouTubeAnalytics",
            "YouTubeReporting"
        ]
    }
}

下载发布版本

如果您不想使用composer，可以下载整个包。在发布页面列出了所有稳定版本。下载任何名为google-api-php-client-[RELEASE_NAME].zip的文件，该文件包含此库及其依赖项。

解压您下载的zip文件，并在您的项目中包含自动加载器

require_once '/path/to/google-api-php-client/vendor/autoload.php';

有关安装和设置的其他说明，请参阅文档。

示例

在examples/目录中查看关键客户端功能的示例。您可以通过运行内置的php网络服务器在浏览器中查看它们。

$ php -S localhost:8000 -t examples/

然后浏览到您指定的主机和端口（在上面的示例中，https://:8000）。

基本示例

// include your composer dependencies
require_once 'vendor/autoload.php';

$client = new Google\Client();
$client->setApplicationName("Client_Library_Examples");
$client->setDeveloperKey("YOUR_APP_KEY");

$service = new Google\Service\Books($client);
$query = 'Henry David Thoreau';
$optParams = [
  'filter' => 'free-ebooks',
];
$results = $service->volumes->listVolumes($query, $optParams);

foreach ($results->getItems() as $item) {
  echo $item['volumeInfo']['title'], "<br /> \n";
}

使用OAuth进行身份验证

此示例可以在examples/simple-file-upload.php中查看。

按照说明创建Web应用程序凭据
下载JSON凭据

使用Google\Client::setAuthConfig设置这些凭据的路径

$client = new Google\Client();
$client->setAuthConfig('/path/to/client_credentials.json');

设置您将要调用的API所需的范围

$client->addScope(Google\Service\Drive::DRIVE);

设置您应用程序的重定向URI

// Your redirect URI can be any registered URI, but in this example
// we redirect back to this same page
$redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
$client->setRedirectUri($redirect_uri);

在处理重定向URI的脚本中，将授权代码交换为访问令牌

if (isset($_GET['code'])) {
    $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
}

使用服务账户进行身份验证

此示例可以在examples/service-account.php中查看。

某些API（如YouTube数据API）不支持服务账户。如果API调用返回意外的401或403错误，请查看特定API的文档。

按照说明创建服务账户
下载JSON凭据
使用环境变量GOOGLE_APPLICATION_CREDENTIALS设置这些凭据的路径
```
putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');
```

告诉Google客户端使用您的服务账户凭据进行身份验证

$client = new Google\Client();
$client->useApplicationDefaultCredentials();

设置您将要调用的API所需的范围

$client->addScope(Google\Service\Drive::DRIVE);

如果您已将域全局访问委托给服务账户并想冒充用户账户，请使用setSubject方法指定用户账户的电子邮件地址
```
$client->setSubject($user_to_impersonate);
```

如何使用特定的JSON键

如果您想使用特定的JSON键而不是使用GOOGLE_APPLICATION_CREDENTIALS环境变量，您可以这样做

$jsonKey = [
   'type' => 'service_account',
   // ...
];
$client = new Google\Client();
$client->setAuthConfig($jsonKey);

发送请求

在google-api-php-client-services中用于调用API的类是自动生成的。它们直接映射到APIs Explorer中找到的JSON请求和响应。

向Datastore API发送的JSON请求看起来像这样

POST https://datastore.googleapis.com/v1beta3/projects/YOUR_PROJECT_ID:runQuery?key=YOUR_API_KEY

{
    "query": {
        "kind": [{
            "name": "Book"
        }],
        "order": [{
            "property": {
                "name": "title"
            },
            "direction": "descending"
        }],
        "limit": 10
    }
}

使用此库，相同的调用看起来可能像这样

// create the datastore service class
$datastore = new Google\Service\Datastore($client);

// build the query - this maps directly to the JSON
$query = new Google\Service\Datastore\Query([
    'kind' => [
        [
            'name' => 'Book',
        ],
    ],
    'order' => [
        'property' => [
            'name' => 'title',
        ],
        'direction' => 'descending',
    ],
    'limit' => 10,
]);

// build the request and response
$request = new Google\Service\Datastore\RunQueryRequest(['query' => $query]);
$response = $datastore->projects->runQuery('YOUR_DATASET_ID', $request);

但是，由于JSON API的每个属性都有一个对应的生成类，上述代码也可以这样编写

// create the datastore service class
$datastore = new Google\Service\Datastore($client);

// build the query
$request = new Google\Service\Datastore_RunQueryRequest();
$query = new Google\Service\Datastore\Query();
//   - set the order
$order = new Google\Service\Datastore_PropertyOrder();
$order->setDirection('descending');
$property = new Google\Service\Datastore\PropertyReference();
$property->setName('title');
$order->setProperty($property);
$query->setOrder([$order]);
//   - set the kinds
$kind = new Google\Service\Datastore\KindExpression();
$kind->setName('Book');
$query->setKinds([$kind]);
//   - set the limit
$query->setLimit(10);

// add the query to the request and make the request
$request->setQuery($query);
$response = $datastore->projects->runQuery('YOUR_DATASET_ID', $request);

使用哪种方法取决于个人喜好，但如果不首先了解API的JSON语法，将很难使用此库，因此建议在使用任何服务之前先查看APIs Explorer。

直接发送HTTP请求

如果希望外部应用程序使用Google身份验证，或者此库中尚未提供Google API，可以直接发送HTTP请求。

如果您只安装此客户端以验证自己的HTTP客户端请求，则应使用google/auth。

authorize方法返回一个授权的Guzzle客户端，因此使用此客户端发出的任何请求都将包含相应的授权。

// create the Google client
$client = new Google\Client();

/**
 * Set your method for authentication. Depending on the API, This could be
 * directly with an access token, API key, or (recommended) using
 * Application Default Credentials.
 */
$client->useApplicationDefaultCredentials();
$client->addScope(Google\Service\Plus::PLUS_ME);

// returns a Guzzle HTTP Client
$httpClient = $client->authorize();

// make an HTTP request
$response = $httpClient->get('https://www.googleapis.com/plus/v1/people/me');

缓存

建议使用另一个缓存库以提高性能。这可以通过将一个PSR-6兼容的库传递给客户端来实现。

use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use Cache\Adapter\Filesystem\FilesystemCachePool;

$filesystemAdapter = new Local(__DIR__.'/');
$filesystem        = new Filesystem($filesystemAdapter);

$cache = new FilesystemCachePool($filesystem);
$client->setCache($cache);

在这个例子中，我们使用PHP Cache。使用Composer将此添加到您的项目中。

composer require cache/filesystem-adapter

更新令牌

当使用刷新令牌或服务账户凭证时，当授予新的访问令牌时执行一些操作可能很有用。为此，将可调用的函数传递给客户端上的setTokenCallback方法。

$logger = new Monolog\Logger();
$tokenCallback = function ($cacheKey, $accessToken) use ($logger) {
  $logger->debug(sprintf('new access token received at cache key %s', $cacheKey));
};
$client->setTokenCallback($tokenCallback);

使用Charles调试您的HTTP请求

通过查看原始HTTP请求来调试API调用通常非常有用。此库支持使用Charles Web代理。下载并运行Charles，然后使用以下代码捕获Charles的所有HTTP流量：

// FOR DEBUGGING ONLY
$httpClient = new GuzzleHttp\Client([
    'proxy' => 'localhost:8888', // by default, Charles runs on localhost port 8888
    'verify' => false, // otherwise HTTPS requests will fail.
]);

$client = new Google\Client();
$client->setHttpClient($httpClient);

现在，此库发出的所有调用都将显示在Charles UI中。

在Charles中查看SSL请求还需要进行一个额外步骤。转到Charles > 代理 > SSL代理设置，并添加您想要捕获的域名。对于Google API，这通常是*.googleapis.com。

直接控制HTTP客户端配置

Google API客户端使用Guzzle作为其默认的HTTP客户端。这意味着您可以使用与使用Guzzle的任何应用程序相同的方式控制您的HTTP请求。

例如，如果我们希望对每个请求应用一个引用者。

use GuzzleHttp\Client;

$httpClient = new Client([
    'headers' => [
        'referer' => 'mysite.com'
    ]
]);

$client = new Google\Client();
$client->setHttpClient($httpClient);

Guzzle的其他功能，如处理程序和中间件，提供了更多的控制。

特定服务的示例

YouTube：https://github.com/youtube/api-samples/tree/master/php

我如何贡献？

有关更多信息，请参阅贡献页面。特别是，我们喜欢拉取请求 - 但请确保您已签署贡献者许可协议。

常见问题解答

如果某些功能不起作用，我该怎么做？

有关库的支持，最佳提问地点是StackOverflow上的google-api-php-client标签： https://stackoverflow.com/questions/tagged/google-api-php-client

如果库中存在特定错误，请在GitHub问题跟踪器中提交问题，包括失败的代码示例和任何特定的错误。也可以提交功能请求，只要它们是核心库请求，而不是特定于API：对于这些，请参考个别API的文档，以确定最佳提交请求的位置。请尽可能提供一个清晰的声明，说明该功能将解决的问题。

我想看看X的示例！

如果X是库的一个功能，请归档！如果X是使用特定服务的一个例子，最佳的选择是去那些特定API的团队——我们更倾向于链接到他们的例子，而不是将它们添加到库中，因为这样他们可以针对库的具体版本进行标记。如果你有其他API的例子，请告诉我们，我们将很乐意在上面的README中添加链接！

为什么一些Google\Service类的名字这么奇怪？

Google\Service类通常是从API发现文档中自动生成的：[API发现](https://developers.google.com/discovery/)。有时API会添加一些名字不寻常的新特性，这可能会导致PHP类中出现一些意外或非标准的命名风格。

如何处理非JSON响应类型？

某些服务默认返回XML或类似的格式，而不是JSON，而库支持的是JSON。你可以通过向方法调用的最后参数添加一个'alt'参数来请求JSON响应

$opt_params = array(
  'alt' => "json"
);

如何将一个字段设置为null？

库会将对象发送到Google API时的null值移除，因为这是所有未初始化属性默认的值。为了解决这个问题，将你想要设置为null的字段设置为Google\Model::NULL_VALUE。这是一个占位符，在通过网络发送时会替换为真正的null。

代码质量

使用PHPUnit运行PHPUnit测试。你可以在BaseTest.php中配置API密钥和令牌以运行所有调用，但这需要在Google开发者控制台中做一些设置。

phpunit tests/

编码风格

要检查编码风格违规，运行

vendor/bin/phpcs src --standard=style/ruleset.xml -np

要自动修复（可修复的）编码风格违规，运行

vendor/bin/phpcbf src --standard=style/ruleset.xml

triwinvendor / google-apiclient

维护者

详细信息