README

PHP的Google API客户端库

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

Google API客户端库允许您在服务器上操作Google API，如Gmail、Drive或YouTube。

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

Google云平台

对于Google云平台API，如数据存储、云存储、发布/订阅和计算引擎，我们建议使用Google云客户端库。有关支持的Google云客户端库的完整列表，请参阅googleapis/google-cloud-php。

要求

PHP 5.6.0或更高版本

开发者文档

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

安装

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

Composer

首选方法是使用composer。如果您尚未安装composer，请按照安装说明进行操作。

一旦安装了composer，请在项目的根目录中执行以下命令来安装此库

composer require google/apiclient:^2.12.1

最后，务必包含自动加载器

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.12.1"
    },
    "scripts": {
        "pre-autoload-dump": "Google\\Task\\Composer::cleanup"
    },
    "extra": {
        "google/apiclient-services": [
            "Drive",
            "YouTube"
        ]
    }
}

此示例将删除除"Drive"和"YouTube"之外的所有服务，当运行composer update或全新的composer install时。

重要：如果您在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请求和响应。

对数据存储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。为了解决这个问题，将您想要设置为null的字段设置为Google\Model::NULL_VALUE。这是一个占位符，在通过网络发送时会替换为真正的null。

代码质量

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

phpunit tests/

编码风格

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

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

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

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

pdobrovolny / apiclient

维护者

详细信息