Ruby Google Calendar: List Calendars

Back to Index

Returns entries on the user's calendar list.

Documentation: https://developers.google.com/google-apps/calendar/v3/reference/calendarList/list

require 'chilkat'

rest = Chilkat::CkRest.new()

#   Provide a previously obtained OAuth2 access token.
oauth2 = Chilkat::CkOAuth2.new()
oauth2.put_AccessToken("OAUTH2_ACCESS_TOKEN")
rest.SetAuthOAuth2(oauth2)

success = rest.Connect("www.googleapis.com",443,true,true)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

sbJson = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/calendar/v3/users/me/calendarList",sbJson)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

if (rest.get_ResponseStatusCode() != 200)
    print "Received error response code: " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response body:" + "\n";
    print sbJson.getAsString() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.LoadSb(sbJson)

#  The following code parses the JSON response.
#  A sample JSON response is shown below the sample code.

kind = json.stringOf("kind")
etag = json.stringOf("etag")
nextSyncToken = json.stringOf("nextSyncToken")
i = 0
count_i = json.SizeOfArray("items")
while i < count_i
    json.put_I(i)
    kind = json.stringOf("items[i].kind")
    etag = json.stringOf("items[i].etag")
    id = json.stringOf("items[i].id")
    summary = json.stringOf("items[i].summary")
    timeZone = json.stringOf("items[i].timeZone")
    colorId = json.stringOf("items[i].colorId")
    backgroundColor = json.stringOf("items[i].backgroundColor")
    foregroundColor = json.stringOf("items[i].foregroundColor")
    selected = json.BoolOf("items[i].selected")
    accessRole = json.stringOf("items[i].accessRole")
    primary = json.BoolOf("items[i].primary")
    j = 0
    count_j = json.SizeOfArray("items[i].defaultReminders")
    while j < count_j
        json.put_J(j)
        method = json.stringOf("items[i].defaultReminders[j].method")
        minutes = json.IntOf("items[i].defaultReminders[j].minutes")
        j = j + 1
    end
    j = 0
    count_j = json.SizeOfArray("items[i].notificationSettings.notifications")
    while j < count_j
        json.put_J(j)
        type = json.stringOf("items[i].notificationSettings.notifications[j].type")
        method = json.stringOf("items[i].notificationSettings.notifications[j].method")
        j = j + 1
    end
    i = i + 1
end

print "Example Completed." + "\n";

Sample JSON Response Body

{
 "kind": "calendar#calendarList",
 "etag": "\"p33gdfl6bualde0g\"",
 "nextSyncToken": "CODX1MvyqtcCEhhzdXBwb3J0QGNoaWxrYXRjbG91ZC5jb20=",
 "items": [
  {
   "kind": "calendar#calendarListEntry",
   "etag": "\"1465249947472000\"",
   "id": "support@chilkatcloud.com",
   "summary": "support@chilkatcloud.com",
   "timeZone": "America/Chicago",
   "colorId": "14",
   "backgroundColor": "#9fe1e7",
   "foregroundColor": "#000000",
   "selected": true,
   "accessRole": "owner",
   "defaultReminders": [
    {
     "method": "popup",
     "minutes": 10
    }
   ],
   "notificationSettings": {
    "notifications": [
     {
      "type": "eventCreation",
      "method": "email"
     },
     {
      "type": "eventChange",
      "method": "email"
     },
     {
      "type": "eventCancellation",
      "method": "email"
     },
     {
      "type": "eventResponse",
      "method": "email"
     }
    ]
   },
   "primary": true
  },
  {
   "kind": "calendar#calendarListEntry",
   "etag": "\"1502373382732000\"",
   "id": "#contacts@group.v.calendar.google.com",
   "summary": "Contacts",
   "timeZone": "America/Chicago",
   "colorId": "13",
   "backgroundColor": "#92e1c0",
   "foregroundColor": "#000000",
   "selected": true,
   "accessRole": "reader",
   "defaultReminders": []
  },
  {
   "kind": "calendar#calendarListEntry",
   "etag": "\"1502373376447000\"",
   "id": "en.usa#holiday@group.v.calendar.google.com",
   "summary": "Holidays in United States",
   "timeZone": "America/Chicago",
   "colorId": "8",
   "backgroundColor": "#16a765",
   "foregroundColor": "#000000",
   "selected": true,
   "accessRole": "reader",
   "defaultReminders": []
  }
 ]
}