maximing/google-apiclient

Google API 客户端库

维护者

详细信息

github.com/maximing/google-api-php-client

主页

源代码

安装: 96

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

Forks: 3,520

v2.2.4 2019-08-19 18:09 UTC

Requires

Requires (Dev)

Suggests

Apache-2.0 d6c7563bdf88d6a0719ea63e21c74dc86032364e

google

This package is auto-updated.

Last update: 2024-09-28 22:37:38 UTC

README

Build Status

PHP 的 Google API 客户端库

Google API 客户端库允许您在服务器上使用 Google API，如 Google+、Drive 或 YouTube。

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

注意 此客户端库的活跃维护（v2）版本需要 PHP 5.4 或更高版本。如果您需要支持 PHP 5.2 或 5.3，请使用 v1 分支。

Google Cloud Platform

对于 Google Cloud Platform API，如 Datastore、Cloud Storage 或 Pub/Sub，我们建议使用正在积极开发的 GoogleCloudPlatform/google-cloud-php。

需求

开发者文档

在 docs 文件夹 中提供了关于使用此库的详细指南。

安装

您可以使用 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。

  1. 按照说明 创建网络应用程序凭据

  2. 下载 JSON 凭据

  3. 使用 Google_Client::setAuthConfig 设置这些凭据的路径

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

  4. 设置您将要调用的 API 所需的权限范围

    $client->addScope(Google_Service_Drive::DRIVE);

  5. 设置您应用程序的重定向 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);

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

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

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

有关此示例，请参阅 examples/service-account.php。

一些API（例如YouTube数据API）不支持服务帐户。如果API调用返回意外的401或403错误，请检查具体的API文档。

  1. 按照以下说明创建服务帐户

  2. 下载 JSON 凭据

  3. 使用环境变量GOOGLE_APPLICATION_CREDENTIALS设置这些凭证的路径

    putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');

  4. 告诉Google客户端使用您的服务帐户凭证进行认证

    $client = new Google_Client();
$client->useApplicationDefaultCredentials();

  5. 设置您将要调用的 API 所需的权限范围

    $client->addScope(Google_Service_Drive::DRIVE);

  6. 如果您已将域范围访问权限委托给服务帐户，并且想要模拟用户帐户，请使用setSubject方法指定用户帐户的电子邮件地址

    $client->setSubject($user_to_impersonate);

发起请求

在google-api-php-client-services中用于调用API的类是自动生成的。它们直接映射到API探索器中找到的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语法之前，很难使用这个库，因此建议在使用任何服务之前查看API探索器。

直接发起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兼容的库来实现

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有奇怪的名字？

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。为了解决这个问题，将您想设置为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