(Objective-C) Google Contacts - Retrieve as JSON

Demonstrates how to retrieve Google Contacts as JSON.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoJsonObject.h>
#import <CkoAuthGoogle.h>
#import <CkoRest.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

// 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

CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
BOOL success = [jsonToken LoadFile: @"qa_data/tokens/googleContacts.json"];
if (success != YES) {
    NSLog(@"%@",@"Failed to load googleContacts.json");
    return;
}

CkoAuthGoogle *gAuth = [[CkoAuthGoogle alloc] init];
gAuth.AccessToken = [jsonToken StringOf: @"access_token"];

CkoRest *rest = [[CkoRest alloc] init];

// Connect using TLS.
BOOL bAutoReconnect = YES;
success = [rest Connect: @"www.google.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];

// Provide the authentication credentials (i.e. the access token)
[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

// To get the contacts data in JSON format, set the "alt" query parameter to "json"
[rest AddQueryParam: @"alt" value: @"json"];
[rest AddHeader: @"GData-Version" value: @"3.0"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [rest FullRequestNoBodySb: @"GET" uriPath: @"/m8/feeds/contacts/default/full" sb: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// A successful response will have a status code equal to 200.
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@%d",@"response status code = ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@%@",@"response status text = ",rest.ResponseStatusText);
    NSLog(@"%@%@",@"response header: ",rest.ResponseHeader);
    NSLog(@"%@%@",@"response body: ",[sbResponseBody GetAsString]);
    return;
}

// If the 200 response was received, then the contacts JSON is contained
// in the response body.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json LoadSb: sbResponseBody];
json.EmitCompact = NO;

// Save the pretty-printed JSON response to a file.
[sbResponseBody Clear];
[json EmitSb: sbResponseBody];
[sbResponseBody WriteFile: @"qa_output/google_contacts.json" charset: @"utf-8" emitBom: NO];

// Parse the Google Contacts JSON, and iterate over the contacts..
int totalResults = [[json IntOf: @"feed.openSearch$totalResults.$t"] intValue];
int startIndex = [[json IntOf: @"feed.openSearch$startIndex.$t"] intValue];
int itemsPerPage = [[json IntOf: @"feed.openSearch$itemsPerPage.$t"] intValue];
NSLog(@"%@%d",@"totalResults = ",totalResults);
NSLog(@"%@%d",@"startIndex = ",startIndex);
NSLog(@"%@%d",@"itemsPerPage = ",itemsPerPage);

int numEntries = [[json SizeOfArray: @"feed.entry"] intValue];
int i = 0;
while (i < numEntries) {
    json.I = [NSNumber numberWithInt: i];
    NSLog(@"%d%@",i + 1,@" ----");
    NSLog(@"%@%@",@"title: ",[json StringOf: @"feed.entry[i].title.$t"]);

    NSString *fullName = [json StringOf: @"feed.entry[i].gd$name.gd$fullName.$t"];
    if (json.LastMethodSuccess == YES) {
        NSLog(@"%@%@",@"fullName: ",fullName);
    }

    // There can be multiple email addresses, so it's stored as a JSON array..
    int numEmailAddresses = [[json SizeOfArray: @"feed.entry[i].gd$email"] intValue];
    int j = 0;
    while (j < numEmailAddresses) {
        NSString *emailAddress = [json StringOf: @"feed.entry[i].gd$email[j].address"];
        if (json.LastMethodSuccess == YES) {
            NSLog(@"%@%@",@"email address: ",emailAddress);
        }

        j = j + 1;
    }

    i = i + 1;
}

// A sample Google Contacts JSON response:

// 	{ 
// 	  "version": "1.0",
// 	  "encoding": "UTF-8",
// 	  "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": "\"QHw5eTVSLyt7I2A9XRFaE0kNTwI.\"",
// 	    "id": { 
// 	      "$t": "chilkat.support@gmail.com"
// 	    },
// 	    "updated": { 
// 	      "$t": "2016-11-17T01:57:41.221Z"
// 	    },
// 	    "category": [
// 	      { 
// 	        "scheme": "http://schemas.google.com/g/2005#kind",
// 	        "term": "http://schemas.google.com/contact/2008#contact"
// 	      }
// 	    ],
// 	    "title": { 
// 	      "$t": "Chilkat Support's Contacts"
// 	    },
// 	    "link": [
// 	      { 
// 	        "rel": "alternate",
// 	        "type": "text/html",
// 	        "href": "https://www.googleapis.com/"
// 	      },
// 	      { 
// 	        "rel": "http://schemas.google.com/g/2005#feed",
// 	        "type": "application/atom+xml",
// 	        "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full"
// 	      },
// 	      { 
// 	        "rel": "http://schemas.google.com/g/2005#post",
// 	        "type": "application/atom+xml",
// 	        "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full"
// 	      },
// 	      { 
// 	        "rel": "http://schemas.google.com/g/2005#batch",
// 	        "type": "application/atom+xml",
// 	        "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full/batch"
// 	      },
// 	      { 
// 	        "rel": "self",
// 	        "type": "application/atom+xml",
// 	        "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full?max-results=25&alt=json"
// 	      },
// 	      { 
// 	        "rel": "next",
// 	        "type": "application/atom+xml",
// 	        "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full?max-results=25&alt=json&start-index=26"
// 	      }
// 	    ],
// 	    "author": [
// 	      { 
// 	        "name": { 
// 	          "$t": "Chilkat Support"
// 	        },
// 	        "email": { 
// 	          "$t": "chilkat.support@gmail.com"
// 	        }
// 	      }
// 	    ],
// 	    "generator": { 
// 	      "version": "1.0",
// 	      "uri": "http://www.google.com/m8/feeds",
// 	      "$t": "Contacts"
// 	    },
// 	    "openSearch$totalResults": { 
// 	      "$t": "350"
// 	    },
// 	    "openSearch$startIndex": { 
// 	      "$t": "1"
// 	    },
// 	    "openSearch$itemsPerPage": { 
// 	      "$t": "25"
// 	    },
// 	    "entry": [
// 	      { 
// 	        "id": { 
// 	          "$t": "http://www.google.com/m8/feeds/contacts/chilkat.support%40gmail.com/base/0"
// 	        },
// 	        "gd$etag": "\"SX8zcTVSLyt7I2A9WxBXFU4MQwI.\"",
// 	        "updated": { 
// 	          "$t": "2010-01-26T20:07:48.189Z"
// 	        },
// 	        "app$edited": { 
// 	          "xmlns$app": "http://www.w3.org/2007/app",
// 	          "$t": "2010-01-26T20:07:48.189Z"
// 	        },
// 	        "category": [
// 	          { 
// 	            "scheme": "http://schemas.google.com/g/2005#kind",
// 	            "term": "http://schemas.google.com/contact/2008#contact"
// 	          }
// 	        ],
// 	        "title": { 
// 	          "$t": "Joe Sample"
// 	        },
// 	        "link": [
// 	          { 
// 	            "rel": "http://schemas.google.com/contacts/2008/rel#photo",
// 	            "type": "image/*",
// 	            "href": "https://www.googleapis.com/m8/feeds/photos/media/chilkat.support%40gmail.com/0"
// 	          },
// 	          { 
// 	            "rel": "self",
// 	            "type": "application/atom+xml",
// 	            "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full/0"
// 	          },
// 	          { 
// 	            "rel": "edit",
// 	            "type": "application/atom+xml",
// 	            "href": "https://www.googleapis.com/m8/feeds/contacts/chilkat.support%40gmail.com/full/0"
// 	          }
// 	        ],
// 	        "gd$name": { 
// 	          "gd$fullName": { 
// 	            "$t": "Joe Sample"
// 	          },
// 	          "gd$givenName": { 
// 	            "$t": "Joe"
// 	          },
// 	          "gd$familyName": { 
// 	            "$t": "Sample"
// 	          }
// 	        },
// 	        "gd$email": [
// 	          { 
// 	            "address": "somebody@gmail.com",
// 	            "primary": "true",
// 	            "rel": "http://schemas.google.com/g/2005#other"
// 	          }
// 	        ]
// 	      },
// 		... more entries ...
//