php google contacts v3 api

PHP Google Contactos V3 API

Biblioteca PHP para la API de Google Contacts (V3)

Nota: Si está comenzando un nuevo proyecto, recomendamos encarecidamente usar nuestro paquete de API PHP Google People. Es más capaz que este paquete y utiliza una API más nueva que probablemente será compatible con más tiempo.

Instalación y dependencias

Este paquete y sus dependencias se pueden instalar utilizando composer .

Simplemente ejecute composer require rapidwebltd/php-google-contacts-v3-api .

Configuración

1. Instale las dependencias requeridas. Consulte la sección 'Dependencias' arriba.
2. Copie o cambie el nombre .config_blank.json a .config.json . Tenga en cuenta el punto ( . ) Al comienzo del nombre del archivo.
3. Complete el clientID , clientSecret y redirectUri en .config.json .

• Tenga en cuenta que redirectUri debe configurarse para apuntar hacia el archivo redirect-handler.php .
• El clientID y clientSecret se pueden encontrar en la consola de desarrolladores de Google en https://console.developers.google.com/ en 'APIS & Auth' -> 'Credenciales', después de habilitar la API de contactos.

4. Vaya a authorise-application.php en un navegador web. Esto debería darle una URL para autorizar su aplicación para los contactos de Google.
5. Vaya a la URL de autorización proporcionada por el paso anterior.
6. Acepte los permisos solicitados en la página que se muestra. Luego debe ser redirigido de nuevo al archivo redirect-handler.php .
7. La página generada por el archivo redirect-handler.php debe presentarle un token de actualización. Copie esto en su .config.json .
8. ¡La configuración está lista!

Uso

Después de que se haya instalado la biblioteca y se hayan completado los pasos de configuración y asociación de cuentas, puede hacer uso de la biblioteca.

Si su marco no hace esto por usted, recuerde incluir el archivo de proveedores para vendor/autoload.php en cualquier página en las que desee utilizar esta biblioteca.

Recuperando los contactos de Google

El siguiente código recuperará todos los contactos de la cuenta de Google asociada.

 $ contacts = rapidweb  googlecontacts  factories ContactFactory:: getAll ();

var_dump ( $ contacts );

El método ContactFactory::getAll() devolverá una matriz de objetos Contact . Los detalles del contacto estarán disponibles como variables de miembros públicos de estos objetos.

El selfURL contenido en cada objeto Contact es la referencia única a este contacto particular. Si necesita recuperar un contacto específico en el futuro, deberá almacenar este selfURL .

Para recuperar un contacto específico (por su selfurl), use el siguiente código.

 $ selfURL = " ... " ;

$ contact = rapidweb  googlecontacts  factories ContactFactory:: getBySelfURL ( $ selfURL );

var_dump ( $ contact );

Este método ContactFactory::getBySelfURL devolverá un solo objeto Contact .

Se accede a las propiedades de contacto de Google de la siguiente manera.

 $ selfURL = " ... " ;

$ contact = rapidweb  googlecontacts  factories ContactFactory:: getBySelfURL ( $ selfURL );

echo $ contact -> name ;
echo $ contact -> phoneNumber ;
echo $ contact -> email ;
echo $ contact -> content ;

Actualización de contactos de Google existentes

La actualización de los contactos de Google usando esta biblioteca se realiza de manera muy orientada a objetos.

Primero debe recuperar un objeto Contact utilizando uno de los métodos mencionados anteriormente. Luego puede modificar las variables de miembro público del objeto de contacto. Para guardar estos cambios en el servicio de Contactos de Google, luego pasa el objeto modificado al método ContactFactory::submitUpdates($contact) .

El siguiente código demuestra en su totalidad recuperando un contacto, modificándolo y enviando las actualizaciones.

 $ selfURL = " ... " ;

$ contact = rapidweb  googlecontacts  factories ContactFactory:: getBySelfURL ( $ selfURL );

var_dump ( $ contact );

$ contact -> name = ' Test ' ;
$ contact -> phoneNumber = ' 07812363789 ' ;
$ contact -> email = ' [email protected] ' ;
$ contact -> content = ' Note for example ' ;

$ contactAfterUpdate = rapidweb  googlecontacts  factories ContactFactory:: submitUpdates ( $ contact );

var_dump ( $ contactAfterUpdate );

Creación de nuevos contactos de Google

Crear un nuevo contacto de Google es muy fácil. Simplemente llame al método ContactFactory::create($name, $phoneNumber, $emailAddress) , pasando a través de los parámetros apropiados. Este método devolverá el contacto creado como un objeto Contact , incluido su selfURL recién asignado.

 $ name = " Frodo Baggins " ;
$ phoneNumber = " 06439111222 " ;
$ emailAddress = " [email protected] " ;
$ note = " Note for example " ;

$ newContact = rapidweb  googlecontacts  factories ContactFactory:: create ( $ name , $ phoneNumber , $ emailAddress , $ note );

Anulación del archivo de configuración

Cada método tiene un argumento opcional para la anulación del archivo de configuración. Es útil cuando desea usar el trabajo con múltiples cuentas de Google al mismo tiempo.

 $ customConfig = ( object ) array (
    ' clientID ' => ' <clientId which you get according to setup above> ' ,
    ' clientSecret ' => ' <clientSecret which you get according to setup above> ' ,
    ' redirectUri ' => ' <your redirect uri> ' ,
    ' developerKey ' => ' <developer key> ' ,
    ' refreshToken ' => ' <refresh token specific for google account> '
);

$ contacts = ContactFactory:: getAll ( $ customConfig );

Debe definir todas las variables ya que la configuración original se ignora por completo. Para ser más precisos, no tiene que existir en absoluto.

Ejemplos

Eche un vistazo a los siguientes archivos para ver ejemplos básicos de cómo recuperar contactos. También se pueden utilizar para asegurarse de haber asociado actualmente su cuenta de Google con la biblioteca.

• test.php
• test_individual.php