README

PHP Google API 客户端库

描述

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

测试版

此库处于测试版。我们对库的稳定性和功能感到足够自信，希望您能在其上构建真实的生产应用程序。我们将努力支持库的公开和保护表面，并在未来保持向后兼容性。尽管我们仍在测试版，但我们保留在不兼容的情况下进行更改的权利。

要求

PHP 5.4.0 或更高版本

开发者文档

http://developers.google.com/api-client-library/php

安装

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

Composer

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

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

composer require google/apiclient:^2.0

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

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

下载发布版本

如果您讨厌使用 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);
$optParams = array('filter' => 'free-ebooks');
$results = $service->volumes->listVolumes('Henry David Thoreau', $optParams);

foreach ($results 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']);
    $client->setAccessToken($token);
}

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

此示例可参见 examples/service-account.php。

按照说明进行操作以创建服务帐户
下载 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);
```

发送请求

在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请求。

《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兼容的库传递给客户端来实现

$cache = new Stash\Pool(new Stash\Driver\FileSystem);
$client->setCache($cache);

在此示例中，我们使用StashPHP。使用composer将此添加到您的项目中

composer require tedivm/stash

更新令牌

当使用刷新令牌或服务帐户凭据时，当新访问令牌被授予时执行某些操作可能很有用。为此，将可调用的参数传递给客户端上的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 Proxy。下载并运行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。

服务特定示例

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

常见问题解答

如果某事物不起作用，我该怎么办？

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

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

我如何贡献代码？

我们接受通过Github Pull Requests的贡献，但所有贡献者都需要遵守标准的Google贡献者许可协议。您可以在文档中找到链接和更多说明：[https://developers.google.com/api-client-library/php/contribute](https://developers.google.com/api-client-library/php/contribute)

我想看到一个X的例子！

如果X是库的功能，请提交！如果X是使用特定服务的示例，最佳的选择是访问那些特定API的团队——我们更喜欢链接到他们的示例，而不是将它们添加到库中，因为这样他们可以针对库的特定版本进行固定。如果您有其他API的示例，请告诉我们，我们将非常乐意在README中添加链接！

为什么你们仍然支持5.2版本？

当我们在1.0.0分支上开始工作时，我们知道库的0.6版本中存在一些基本问题需要修复。当时，我们考察了库的使用情况，以及其他相关项目，并确定PHP 5.2的安装仍然有大量的活跃用户。您可以在WordPress的统计信息中的PHP版本图表中看到这一点：[https://wordpresstheme.cn/about/stats/](https://wordpresstheme.cn/about/stats/)。我们将继续关注我们看到的使用类型，并尽可能利用更新的PHP功能。

为什么Google_..._Service有奇怪的名字？

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

我如何处理非JSON响应类型？

一些服务默认返回XML或类似内容，而不是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

metromix / googleapiclient

维护者

详细信息