php google contacts v3 api

PHP Google Contacts V3 API

Библиотека PHP для API Google Contacts (v3)

Примечание. Если вы начинаете новый проект, мы настоятельно рекомендуем использовать наш пакет PHP Google People API. Он более способен, чем этот пакет, и использует более новый API, который, вероятно, будет поддерживаться дольше.

Установка и зависимости

Этот пакет и его зависимости могут быть установлены с использованием composer .

Просто запустите composer require rapidwebltd/php-google-contacts-v3-api .

Настраивать

1. Установите необходимые зависимости. См. Раздел «Зависимости» выше.
2. Скопировать или переименовать .config_blank.json to .config.json . Обратите внимание на точку ( . ) В начале имени файла.
3. Заполните clientID , clientSecret и redirectUri в .config.json .

• Обратите внимание, что redirectUri следует настроить, чтобы указать на файл redirect-handler.php .
• clientID и clientSecret можно найти в консоли разработчиков Google по адресу https://console.developers.google.com/ в разделе «API & Auth» -> 'Учетные данные', после того, как включили API контактов.

4. Перейдите в authorise-application.php в веб-браузере. Это должно дать вам URL для авторизации вашего приложения для контактов с Google.
5. Перейдите к URL -адресу авторизации, предоставленным предыдущим шагом.
6. Примите разрешения, запрошенные на отображаемой странице. Затем вам следует перенаправить обратно в файл redirect-handler.php .
7. Страница, сгенерированная файлом redirect-handler.php должна предоставить вам токен обновления. Скопируйте это в свой .config.json .
8. Настройка сделана!

Использование

После того, как библиотека была установлена ​​и выполнены шаги ассоциации настройки и учетной записи, вы можете использовать библиотеку.

Если ваша структура не делает этого для вас, не забудьте включить файл «Требуй» vendor/autoload.php на любые страницы, на которых вы хотите использовать эту библиотеку.

Получение контактов с Google

Следующий код будет извлекать все контакты из соответствующей учетной записи Google.

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

var_dump ( $ contacts );

Метод ContactFactory::getAll() вернет массив Contact объектов. Детали контакта будут доступны в качестве публичных переменных членов этих объектов.

selfURL содержащийся в каждом Contact объекте, является уникальной ссылкой на этот конкретный контакт. Если вам необходимо получить конкретный контакт в будущем, вам нужно будет хранить этот 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 = ' [email protected] ' ;
$ 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 = " [email protected] " ;
$ note = " Note for example " ;

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

Переопределение файла конфигурации

Каждый метод имеет необязательный аргумент для переопределения файла конфигурации. Это полезно, когда вы хотите использовать работу с несколькими учетными записями Google одновременно.

 $ 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 );

Вы должны определить все переменные, так как исходная конфигурация полностью игнорируется. Чтобы быть более точным, это вообще не должно существовать.

Примеры

Посмотрите на следующие файлы для основных примеров того, как получить контакты. Они также могут быть использованы, чтобы убедиться, что вы в настоящее время связали свою учетную запись Google с библиотекой.

• test.php
• test_individual.php