php google contacts v3 api

PHP Google Kontakte V3 API

PHP -Bibliothek für die Google Contacts API (v3)

HINWEIS: Wenn Sie ein neues Projekt starten, empfehlen wir dringend, unser PHP Google People API -Paket zu verwenden. Es ist fähiger als dieses Paket und verwendet eine neuere API, die wahrscheinlich länger unterstützt wird.

Installation & Abhängigkeiten

Dieses Paket und seine Abhängigkeiten können mit composer installiert werden.

Ein einfacher composer require rapidwebltd/php-google-contacts-v3-api .

Aufstellen

1. Installieren Sie die erforderlichen Abhängigkeiten. Siehe den Abschnitt "Abhängigkeiten" oben.
2. Kopieren oder umbenennen Sie .config_blank.json in .config.json . Beachten Sie den Punkt ( . ) Zu Beginn des Dateinamens.
3. Füllen Sie die clientID , clientSecret und redirectUri in .config.json aus.

• Beachten Sie, dass redirectUri konfiguriert werden sollte, um auf die Datei redirect-handler.php zu verweisen.
• Die clientID und clientSecret finden Sie in der Google Developers Console unter https://console.developers.google.com/ unter "APIS & Auth" -> 'Anmeldeinformationen ", nachdem die Kontakte -API aktiviert war.

4. Gehen Sie in einem Webbrowser zu authorise-application.php . Dies sollte Ihnen eine URL geben, um Ihre Bewerbung für Google -Kontakte zu autorisieren.
5. Gehen Sie zur Autorisierungs -URL im vorherigen Schritt.
6. Akzeptieren Sie die auf der angezeigten Seite angeforderten Berechtigungen. Sie sollten dann wieder in die Datei redirect-handler.php umgeleitet werden.
7. Die von der Datei redirect-handler.php erzeugte Seite sollte Ihnen dann einen Aktualisierungs-Token vorstellen. Kopieren Sie dies in Ihre .config.json .
8. Setup ist fertig!

Verwendung

Nachdem die Bibliothek installiert wurde und die Schritte für Setup- und Account Association ausgeführt wurden, können Sie die Bibliothek nutzen.

Wenn Ihr Framework dies nicht für Sie erledigt, denken Sie daran, die Datei vendor/autoload.php auf Seiten zu fordern, auf die Sie diese Bibliothek verwenden möchten.

Abrufen von Google -Kontakten

Der folgende Code ruft alle Kontakte aus dem zugehörigen Google -Konto ab.

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

var_dump ( $ contacts );

Die ContactFactory::getAll() -Methode gibt ein Array von Contact zurück. Die Details des Kontakts sind als öffentliche Mitgliedsvariablen dieser Objekte verfügbar.

Das in jedem Contact enthaltene selfURL ist die eindeutige Referenz auf diesen bestimmten Kontakt. Wenn Sie in Zukunft einen bestimmten Kontakt abrufen müssen, müssen Sie dieses selfURL speichern.

Verwenden Sie den folgenden Code, um einen bestimmten Kontakt (nach Selfurl) abzurufen.

 $ selfURL = " ... " ;

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

var_dump ( $ contact );

Diese ContactFactory::getBySelfURL -Methode gibt ein einzelnes Contact zurück.

Auf Google -Kontakteigenschaften wird wie folgt zugegriffen.

 $ selfURL = " ... " ;

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

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

Aktualisieren vorhandener Google -Kontakte

Die Aktualisierung von Google -Kontakten mit dieser Bibliothek erfolgt sehr objektorientiert.

Sie müssen zuerst ein Contact mit einer der zuvor genannten Methoden abrufen. Sie können dann die öffentlichen Mitgliedsvariablen des Kontaktobjekts ändern. Um diese Änderungen wieder in den Google -Kontaktdienst zu speichern, übergeben Sie das geänderte Objekt an die Methode ContactFactory::submitUpdates($contact) .

Der folgende Code zeigt in vollem Umfang einen Kontakt, ändert ihn und übermittelt die Aktualisierungen.

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

Erstellen neuer Google -Kontakte

Das Erstellen eines neuen Google -Kontakts ist sehr einfach. Rufen Sie einfach die ContactFactory::create($name, $phoneNumber, $emailAddress) an, die entsprechende Parameter durchlaufen. Diese Methode gibt den erstellten Kontakt als Contact einschließlich des neu zugewiesenen selfURL zurück.

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

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

Konfigurationsdatei -Überschreibung

Jede Methode hat ein optionales Argument für die Überschreibung von Konfigurationsdateien. Es ist nützlich, wenn Sie gleichzeitig die Arbeit mit mehreren Google -Konten verwenden möchten.

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

Sie müssen alle Variablen definieren, da die ursprüngliche Konfiguration vollständig ignoriert ist. Um genauer zu sein, muss es überhaupt nicht existieren.

Beispiele

Schauen Sie sich die folgenden Dateien an, um grundlegende Beispiele für das Abrufen von Kontakten zu finden. Sie können auch verwendet werden, um sicherzustellen, dass Sie Ihr Google -Konto derzeit mit der Bibliothek zugeordnet haben.

• test.php
• test_individual.php