VBScript

Page Through All Contacts

See more Google APIs Examples

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

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

set jsonToken = CreateObject("Chilkat.JsonObject")
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
If (success <> 1) Then
    outFile.WriteLine("Failed to load googleContacts.json")
    WScript.Quit
End If

set gAuth = CreateObject("Chilkat.AuthGoogle")
gAuth.AccessToken = jsonToken.StringOf("access_token")

set rest = CreateObject("Chilkat.Rest")

' Connect using TLS.
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..
' ----------------------------------------------

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

set sbMaxResults = CreateObject("Chilkat.StringBuilder")
success = sbMaxResults.AppendInt(maxResults)
set sbStartIndex = CreateObject("Chilkat.StringBuilder")

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())

    set sbResponseBody = CreateObject("Chilkat.StringBuilder")
    success = rest.FullRequestNoBodySb("GET","/m8/feeds/contacts/default/full",sbResponseBody)
    If (success <> 1) Then
        outFile.WriteLine(rest.LastErrorText)
        WScript.Quit
    End If

    ' A successful response will have a status code equal to 200.
    If (rest.ResponseStatusCode <> 200) Then
        outFile.WriteLine("response status code = " & rest.ResponseStatusCode)
        outFile.WriteLine("response status text = " & rest.ResponseStatusText)
        outFile.WriteLine("response header: " & rest.ResponseHeader)
        outFile.WriteLine("response body: " & sbResponseBody.GetAsString())
        WScript.Quit
    End If

    ' If the 200 response was received, then the contacts XML is contained
    ' in the response body.
    set xml = CreateObject("Chilkat.Xml")
    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")
    startIndex2 = xml.GetChildIntValue("openSearch:startIndex")
    itemsPerPage = xml.GetChildIntValue("openSearch:itemsPerPage")
    outFile.WriteLine("totalResults = " & totalResults)
    outFile.WriteLine("startIndex = " & startIndex2)
    outFile.WriteLine("itemsPerPage = " & itemsPerPage)

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

        idUrl = xml.GetChildContent("entry[i]|id")
        outFile.WriteLine("id: " & idUrl)

        fullName = xml.ChilkatPath("entry[i]|gd:name|gd:fullName|*")
        If (xml.LastMethodSuccess = 1) Then
            outFile.WriteLine("fullName: " & fullName)
        End If

        emailAddress = xml.ChilkatPath("entry[i]|gd:email|(address)")
        If (xml.LastMethodSuccess = 1) Then
            outFile.WriteLine("email address: " & emailAddress)
        End If

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

        End If

        i = i + 1
    Loop

    startIndex = startIndex + maxResults
    loopIteration = loopIteration + 1
Loop

outFile.Close