(Excel) Page Through All Contacts

Demonstrates how to page through the entire list of Google Contacts.

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..
' ----------------------------------------------


startIndex = 1

maxResults = 25
' The totalResults will get updated with the correct value in the 1st loop iteration..

totalResults = 100
' To retrieve the contacts in pages of 25 each, we need to send the following for each page.

' 	GET /m8/feeds/contacts/default/full?max-results=25&start-index=<startIndex>
' 	GData-Version: 3.0

Dim sbMaxResults As Chilkat.StringBuilder
Set sbMaxResults = Chilkat.NewStringBuilder
success = sbMaxResults.AppendInt(maxResults)
Dim sbStartIndex As Chilkat.StringBuilder
Set sbStartIndex = Chilkat.NewStringBuilder


loopIteration = 0
Do While startIndex <= totalResults

    sbStartIndex.Clear 
    success = sbStartIndex.AppendInt(startIndex)

    success = rest.ClearAllHeaders()
    success = rest.ClearAllQueryParams()
    success = rest.AddHeader("GData-Version","3.0")
    success = rest.AddQueryParam("start-index",sbStartIndex.GetAsString())
    success = rest.AddQueryParam("max-results",sbMaxResults.GetAsString())

    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)

    ' 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")

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

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

    ' Iterate over each contact.

    numEntries = xml.NumChildrenHavingTag("entry")

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


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


        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

        ' Find the photo link and check to see if this contact has a photo.

        Set xLink = xml.GetChildWithAttr("link","rel","http://schemas.google.com/contacts/2008/rel#photo")
        If (xml.LastMethodSuccess = True) Then
            ' Get the photo etag.

            bHasPhoto = xLink.HasAttribute("gd:etag")
            If (bHasPhoto = True) Then
                Debug.Print "This contact has a photo."
            End If

        End If

        i = i + 1
    Loop

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1
Loop