README

PHP的Google API客户端库

描述

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

测试版

此库处于测试版。我们对库的稳定性和功能感到满意，希望您能够在它上面构建真实的生产应用。我们将努力支持库的公开和受保护界面，并在将来保持向后兼容。尽管我们仍在测试版，但我们保留做出不兼容更改的权利。如果我们移除了某些功能（通常因为存在更好的功能或该功能不可行），我们的意图是将其弃用，并给开发者充足的时间来更新他们的代码。

要求

• PHP 5.2.1或更高版本
• PHP JSON扩展

注意：由于加密算法的要求，某些功能（服务账户和id令牌验证）需要PHP 5.3.0及以上版本。

开发者文档

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

安装

有关最新安装和配置说明，请参阅文档。

基本示例

请参阅examples/目录中的关键客户端功能示例。

<?php

  require_once 'google-api-php-client/src/Google/autoload.php'; // or wherever autoload.php is located
  
  $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";
  }
  

特定服务示例

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的文档，以确定最佳请求提交位置。请尽量提供清晰的问题说明，说明该功能将解决的问题。

我如何贡献？

我们接受通过Github Pull Requests的贡献，但所有贡献者都需要遵守标准的Google贡献者许可协议。您可以在文档中找到链接和更多说明：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版本图表中看到这一点：[WordPress统计](https://wordpresstheme.cn/about/stats/)。我们将继续关注我们看到的使用类型，并在可能的情况下利用较新的PHP特性。

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

通常，_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运行PHPUnit测试。您可以在BaseTest.php中配置API密钥和令牌以运行所有调用，但这需要在Google开发者控制台中做一些设置。

phpunit tests/

编码风格

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

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

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

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