README

PHP 的 Google API 客户端库

描述

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

测试版

此库处于测试版。我们对库的稳定性和功能感到满意，希望您能在它上面构建实际的生产应用程序。我们将努力支持库的公共和受保护表面，并在未来保持向后兼容性。在我们仍处于测试版期间，我们保留进行不兼容更改的权利。

要求

PHP 5.4.0 或更高版本

Google Cloud Platform APIs

如果您想调用 Google Cloud Platform API，建议您使用 Google Cloud PHP 库而不是此库。

开发者文档

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 > Proxy > SSL Proxying Settings，并添加您想要捕获的域名。在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

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

我想看X的示例！

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

为什么你们还支持5.2？

当我们开始开发1.0.0分支时，我们知道需要修复库的0.6版本中的几个基本问题。当时，我们查看了库的使用情况，以及其他相关项目，并确定仍然有一个庞大而活跃的PHP 5.2安装基础。您可以在WordPress统计信息中的PHP版本图表中看到这一点： https://wordpresstheme.cn/about/stats/。我们将继续关注我们看到的用法类型，并在可能的情况下利用较新的PHP功能。

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

Service类通常是自动从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

wakecent / apiclient

维护者

详情