Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Excel Examples

Web API Categories

ASN.1
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Azure Cloud Storage
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Excel) Google Contacts - Retrieve All Contacts

Demonstrates how to retrieve the full list of contacts for the Google Contacts API.

Download Excel Class Modules

Chilkat Excel Class Modules

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' --------------------------------------------------------------------------------------------------------
' Note: The code for setting up the Chilkat REST object and making the initial connection can be done once.
' Once connected, the REST object may be re-used for many REST API calls.
' (It's a good idea to put the connection setup code in a separate function/subroutine.)
' --------------------------------------------------------------------------------------------------------

' It is assumed we previously obtained an OAuth2 access token.
' This example loads the JSON access token file 
' saved by this example: Get Google Contacts OAuth2 Access Token

Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If (success <> True) Then
    Debug.Print "Failed to load googleContacts.json"
    Exit Sub
End If

Dim gAuth As Chilkat.AuthGoogle
Set gAuth = Chilkat.NewAuthGoogle
gAuth.AccessToken = jsonToken.StringOf("access_token")

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' Connect using TLS.

bAutoReconnect = True
success = rest.Connect("www.google.com",443,True,bAutoReconnect)

' Provide the authentication credentials (i.e. the access token)
Dim success As Boolean
success = rest.SetAuthGoogle(gAuth)

' ----------------------------------------------
' OK, the REST connection setup is completed..
' ----------------------------------------------

' To retrieve the contacts, we need to send the following:

' 	GET /m8/feeds/contacts/default/full
' 	GData-Version: 3.0

success = rest.AddHeader("GData-Version","3.0")

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",sbResponseBody)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' A successful response will have a status code equal to 200.
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print "response status code = "; rest.ResponseStatusCode
    Debug.Print "response status text = "; rest.ResponseStatusText
    Debug.Print "response header: "; rest.ResponseHeader
    Debug.Print "response body: "; sbResponseBody.GetAsString()
    Exit Sub
End If

' If the 200 response was received, then the contacts XML is contained
' in the response body.
Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml
success = xml.LoadSb(sbResponseBody,False)

' See below for a sample response body.
success = xml.SaveXml("qa_output/google_contacts.xml")

' Now let's parse the XML...

' Get the the total number of results, the start index, and the items per page.
' We'll likely NOT get the full list, but will instead get the 1st page.

totalResults = xml.GetChildIntValue("openSearch:totalResults")

startIndex = xml.GetChildIntValue("openSearch:startIndex")

itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
Debug.Print "totalResults = "; totalResults
Debug.Print "startIndex = "; startIndex
Debug.Print "itemsPerPage = "; itemsPerPage

' We'll borrow a method from FileAccess to get the contactId from the URL string (see the code in the while loop)
Dim fac As Chilkat.FileAccess
Set fac = Chilkat.NewFileAccess

' Iterate over each contact.

numEntries = xml.NumChildrenHavingTag("entry")

i = 0
Do While i < numEntries
    xml.I = i
    Debug.Print (i + 1); " ----"
    Debug.Print "title: "; xml.GetChildContent("entry[i]|title")

    ' The entry "id" child contains a URL having this format:
    ' <id>http://www.google.com/m8/feeds/contacts/{userEmail}/base/{contactId}</id>
    ' Let's get the URL and parse the contactId from it..

    idUrl = xml.GetChildContent("entry[i]|id")
    Debug.Print "id: "; idUrl

    ' Use the parsing ability of GetFileName to get the contactId

    contactId = fac.GetFileName(idUrl)
    Debug.Print "contactId: "; contactId


    fullName = xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
    If (xml.LastMethodSuccess = True) Then
        Debug.Print "fullName: "; fullName
    End If


    emailAddress = xml.ChilkatPath("entry[i]|gd:email|(address)")
    If (xml.LastMethodSuccess = True) Then
        Debug.Print "email address: "; emailAddress
    End If

    i = i + 1
Loop

' The response body XML looks something like this:

' 	<feed xmlns="http://www.w3.org/2005/Atom"
' 	    xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/"
' 	    xmlns:gContact="http://schemas.google.com/contact/2008"
' 	    xmlns:batch="http://schemas.google.com/gdata/batch"
' 	    xmlns:gd="http://schemas.google.com/g/2005"
' 	    gd:etag="feedEtag">
' 	  <id>userEmail</id>
' 	  <updated>2008-12-10T10:04:15.446Z</updated>
' 	  <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>
' 	  <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml"
' 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full"/>
' 	  <link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml"
' 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full"/>
' 	  <link rel="http://schemas.google.com/g/2005#batch" type="application/atom+xml"
' 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full/batch"/>
' 	  <link rel="self" type="application/atom+xml"
' 	      href="https://www.google.com/m8/feeds/contacts/userEmail/full?max-results=25"/>
' 	  <author>
' 	    <name>User</name>
' 	    <email>userEmail</email>
' 	  </author>
' 	  <generator version="1.0" uri="http://www.google.com/m8/feeds">
' 	    Contacts
' 	  </generator>
' 	  <openSearch:totalResults>349</openSearch:totalResults>
' 	  <openSearch:startIndex>1</openSearch:startIndex>
' 	  <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
' 	  <entry gd:etag="contactEtag">
' 	    <id>
' 	      http://www.google.com/m8/feeds/contacts/userEmail/base/contactId
' 	    </id>
' 	    <updated>2008-12-10T04:45:03.331Z</updated>
' 	    <app:edited xmlns:app="http://www.w3.org/2007/app">2008-12-10T04:45:03.331Z</app:edited>
' 	    <category scheme="http://schemas.google.com/g/2005#kind"
' 	        term="http://schemas.google.com/contact/2008#contact"/>
' 	    <title>Fitzwilliam Darcy</title>
' 	    <gd:name>
' 	      <gd:fullName>Fitzwilliam Darcy</gd:fullName>
' 	    </gd:name>
' 	    <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*"
' 	        href="https://www.google.com/m8/feeds/photos/media/userEmail/contactId"
' 	        gd:etag="photoEtag"/>
' 	    <link rel="self" type="application/atom+xml"
' 	        href="https://www.google.com/m8/feeds/contacts/userEmail/full/contactId"/>
' 	    <link rel="edit" type="application/atom+xml"
' 	        href="https://www.google.com/m8/feeds/contacts/userEmail/full/contactId"/>
' 	    <gd:phoneNumber rel="http://schemas.google.com/g/2005#home"
' 	        primary="true">
' 	      456
' 	    </gd:phoneNumber>
' 	    <gd:extendedProperty name="pet" value="hamster"/>
' 	    <gContact:groupMembershipInfo deleted="false"
' 	        href="http://www.google.com/m8/feeds/groups/userEmail/base/groupId"/>
'         <gd:email rel="http://schemas.google.com/g/2005#other" address="darcyf@example.com" primary="true" />
' 	  </entry>
' 	  <!-- Other entries ... -->
' 	</feed>
' 

 

© 2000-2022 Chilkat Software, Inc. All Rights Reserved.