boykathemad/google-apiclient-bare

Google API 客户端库

维护者

详情

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

主页

源代码

安装: 8

依赖: 0

建议: 0

安全性: 0

星标: 0

关注者: 1

分支: 3,522

v2.2.1 2017-11-03 01:19 UTC

Requires

Requires (Dev)

Suggests

Apache-2.0 b69b8ac4bf6501793c389d4e013a79d09c85c5f2

google

This package is not auto-updated.

Last update: 2024-09-23 07:34:18 UTC

README

Build Status

PHP Google API 客户端库

库维护

此客户端库受到支持，但仅处于维护模式。我们正在修复必要的错误并添加基本功能，以确保该库继续满足您访问 Google API 的需求。非关键问题将被关闭。如果问题持续存在，则任何问题都可以重新打开。

描述

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

要求

Google Cloud Platform API

如果您想调用 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。

  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。

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

  2. 下载 JSON 凭证

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

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

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

    $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的类是自动生成的。它们直接映射到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请求

如果希望外部应用程序使用谷歌身份验证，或者此库中尚未提供谷歌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 并添加您希望捕获的域。在谷歌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