Visual Basic 6.0

Page Through All Contacts

See more Google APIs Examples

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

Dim success As Long
success = 0

' 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 New ChilkatJsonObject
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If (success <> 1) Then
    Debug.Print "Failed to load googleContacts.json"
    Exit Sub
End If

Dim gAuth As New ChilkatAuthGoogle
gAuth.AccessToken = jsonToken.StringOf("access_token")

Dim rest As New ChilkatRest

' Connect using TLS.
Dim bAutoReconnect As Long
bAutoReconnect = 1
success = rest.Connect("www.google.com",443,1,bAutoReconnect)

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

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

Dim startIndex As Long
startIndex = 1
Dim maxResults As Long
maxResults = 25
' The totalResults will get updated with the correct value in the 1st loop iteration..
Dim totalResults As Long
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 New ChilkatStringBuilder
success = sbMaxResults.AppendInt(maxResults)
Dim sbStartIndex As New ChilkatStringBuilder

Dim loopIteration As Long
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 New ChilkatStringBuilder
    success = rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",sbResponseBody)
    If (success <> 1) 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 New ChilkatXml
    success = xml.LoadSb(sbResponseBody,0)

    ' 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")
    Dim startIndex2 As Long
    startIndex2 = xml.GetChildIntValue("openSearch:startIndex")
    Dim itemsPerPage As Long
    itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
    Debug.Print "totalResults = " & totalResults
    Debug.Print "startIndex = " & startIndex2
    Debug.Print "itemsPerPage = " & itemsPerPage

    ' Iterate over each contact.
    Dim numEntries As Long
    numEntries = xml.NumChildrenHavingTag("entry")
    Dim i As Long
    i = 0
    Do While i < numEntries
        xml.I = i
        Debug.Print (loopIteration * maxResults + i + 1) & " ----"
        Debug.Print "title: " & xml.GetChildContent("entry[i]|title")

        Dim idUrl As String
        idUrl = xml.GetChildContent("entry[i]|id")
        Debug.Print "id: " & idUrl

        Dim fullName As String
        fullName = xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
        If (xml.LastMethodSuccess = 1) Then
            Debug.Print "fullName: " & fullName
        End If

        Dim emailAddress As String
        emailAddress = xml.ChilkatPath("entry[i]|gd:email|(address)")
        If (xml.LastMethodSuccess = 1) Then
            Debug.Print "email address: " & emailAddress
        End If

        ' Find the photo link and check to see if this contact has a photo.
        Dim xLink As ChilkatXml
        Set xLink = xml.GetChildWithAttr("link","rel","http://schemas.google.com/contacts/2008/rel#photo")
        If (xml.LastMethodSuccess = 1) Then
            ' Get the photo etag.
            Dim bHasPhoto As Long
            bHasPhoto = xLink.HasAttribute("gd:etag")
            If (bHasPhoto = 1) Then
                Debug.Print "This contact has a photo."
            End If

        End If

        i = i + 1
    Loop

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1
Loop