php google contacts v3 api
Google Contacts API(V3)的PHP库
注意:如果您启动了一个新项目,我们强烈建议您改用我们的PHP Google People API软件包。它比此软件包更有能力,并且使用了更新的API,该API可能会更长的时间。
安装和依赖项
可以使用composer安装此软件包及其依赖关系。
只需运行composer require rapidwebltd/php-google-contacts-v3-api 。
设置
- 安装所需的依赖项。请参阅上面的“依赖关系”部分。
- 复制或重命名
.config_blank.json到.config.json。注意文件名开头的点(.)。 - 在
.config.json中填写clientID,clientSecret和redirectUri。
- 请注意,
redirectUri应配置为指向redirect-handler.php文件。 - 可以在https://console.devel*ope*rs.*google.com/下在'apis&auth'' - >'凭据''启用Contacts API之后,在Google Developers Console中找到
clientID和clientSecret。
- 转到Web浏览器中的
authorise-application.php。这应该为您提供一个URL,以授权您的Google联系人申请。 - 转到上一步提供的授权URL。
- 接受显示的页面上要求的权限。然后,您应该将其重定向回到
redirect-handler.php文件。 - 然后,由
redirect-handler.php文件生成的页面应为您提供刷新令牌。将其复制到您的.config.json中。 - 设置完成了!
用法
安装库并完成了设置和帐户关联步骤后,您可以使用库。
如果您的框架不为您执行此操作,请记住在您希望使用此库上的任何页面上包含需要vendor/autoload.php文件。
检索Google联系人
以下代码将从关联的Google帐户中检索所有联系人。
$ contacts = rapidweb googlecontacts factories ContactFactory:: getAll ();
var_dump ( $ contacts ); ContactFactory::getAll()方法将返回一个Contact对象的数组。联系人的详细信息将作为这些对象的公共成员变量提供。
每个Contact对象中包含的selfURL是对此特定联系人的唯一引用。如果您将来需要检索特定的联系人,则需要存储此selfURL 。
要检索特定的联系人(通过其自我),请使用以下代码。
$ selfURL = " ... " ;
$ contact = rapidweb googlecontacts factories ContactFactory:: getBySelfURL ( $ selfURL );
var_dump ( $ contact );此ContactFactory::getBySelfURL方法将返回单个Contact对象。
Google联系人属性如下访问。
$ selfURL = " ... " ;
$ contact = rapidweb googlecontacts factories ContactFactory:: getBySelfURL ( $ selfURL );
echo $ contact -> name ;
echo $ contact -> phoneNumber ;
echo $ contact -> email ;
echo $ contact -> content ;更新现有的Google联系人
使用此库的Google联系人更新以非常注重对象的方式完成。
您必须使用前面提到的一种方法首先检索Contact对象。然后,您可以修改联系人对象的公共成员变量。为了将这些更改保存回Google Contacts服务,然后您将修改后的对象传递给ContactFactory::submitUpdates($contact)方法。
以下代码在全面检索联系人,修改并提交更新时说明。
$ selfURL = " ... " ;
$ contact = rapidweb googlecontacts factories ContactFactory:: getBySelfURL ( $ selfURL );
var_dump ( $ contact );
$ contact -> name = ' Test ' ;
$ contact -> phoneNumber = ' 07812363789 ' ;
$ contact -> email = ' test@example.com ' ;
$ contact -> content = ' Note for example ' ;
$ contactAfterUpdate = rapidweb googlecontacts factories ContactFactory:: submitUpdates ( $ contact );
var_dump ( $ contactAfterUpdate );创建新的Google联系人
创建新的Google联系人非常容易。只需调用ContactFactory::create($name, $phoneNumber, $emailAddress)方法,通过适当的参数。此方法将返回创建的联系人作为Contact对象,包括其新分配的selfURL 。
$ name = " Frodo Baggins " ;
$ phoneNumber = " 06439111222 " ;
$ emailAddress = " frodo@example.com " ;
$ note = " Note for example " ;
$ newContact = rapidweb googlecontacts factories ContactFactory:: create ( $ name , $ phoneNumber , $ emailAddress , $ note );配置文件覆盖
每个方法都有可选的配置文件覆盖的参数。当您要同时使用多个Google帐户工作时,这很有用。
$ customConfig = ( object ) array (
' clientID ' => ' ' ,
' clientSecret ' => ' ' ,
' redirectUri ' => ' ' ,
' developerKey ' => ' ' ,
' refreshToken ' => ' '
);
$ contacts = ContactFactory:: getAll ( $ customConfig );您必须定义所有变量,因为原始配置被完全忽略。更确切地说,它根本不必存在。
例子
查看以下文件,以获取如何检索联系人的基本示例。它们还可以用来确保您当前将Google帐户与库相关联。
- test.php
- test_individual.php
通过命令行克隆项目: