(PureBasic) Google Calendar Search Events (List Events with Optional Query Parameters)

See more Google Calendar Examples

Demonstrates how to specify optional query parameters for listing events. This example uses the "q" parameter to free-text search for events, and uses the "timeMin" parameter to specify a lower bound for an event's end time.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; This example uses a previously obtained access token having permission for the 
    ; Google Calendar scope.

    ; In this example, Get Google Calendar OAuth2 Access Token, the access
    ; token was saved to a JSON file.  This example fetches the access token from the file..
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleCalendar.json")
    If CkJsonObject::ckHasMember(jsonToken,"access_token") = 0
        Debug "No access token found."
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    ; We'll want to build a URL with the query params..
    sbUrl.i = CkStringBuilder::ckCreate()
    If sbUrl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbUrl,"https://www.googleapis.com/calendar/v3/calendars/{$calendarId}/events?")

    ; Use the HTTP request object as a helper for creating the URL encoded query param list..
    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Find events with the word "pizza".
    CkHttpRequest::ckAddParam(req,"q","pizza")

    ; Get events for the current date/time or later.
    dt.i = CkDateTime::ckCreate()
    If dt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(dt)
    CkHttpRequest::ckAddParam(req,"timeMin",CkDateTime::ckGetAsTimestamp(dt,0))

    ; Add these query params to the URL:
    CkStringBuilder::ckAppend(sbUrl,CkHttpRequest::ckGetUrlEncodedParams(req))

    ; Examine the URL..
    Debug "URL: " + CkStringBuilder::ckGetAsString(sbUrl)

    ; The URL looks like this:
    ; https://www.googleapis.com/calendar/v3/calendars/{$calendarId}/events?q=pizza&timeMin=2017-08-11T13%3A35%3A28Z

    ; Let's get events in the primary calendar.  A calendar ID could have be used instead of "primary".
    CkHttp::ckSetUrlVar(http,"calendarId","primary")
    sbResponse.i = CkStringBuilder::ckCreate()
    If sbResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,CkStringBuilder::ckGetAsString(sbUrl),sbResponse)
    If success <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkJsonObject::ckDispose(jsonToken)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbUrl)
        CkHttpRequest::ckDispose(req)
        CkDateTime::ckDispose(dt)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

    If CkHttp::ckLastStatus(http) <> 200
        ; Note: If a 401 unauthorized response is received, it likely means that the OAuth2 access token needs
        ; to be refreshed or re-fetched.
        Debug "Error response status: " + Str(CkHttp::ckLastStatus(http))
        Debug CkStringBuilder::ckGetAsString(sbResponse)
        CkJsonObject::ckDispose(jsonToken)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbUrl)
        CkHttpRequest::ckDispose(req)
        CkDateTime::ckDispose(dt)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

    Debug CkStringBuilder::ckGetAsString(sbResponse)

    ; A sample JSON response:
    ; (Code for parsing the Google Calendar events is shown below.)

    ; {
    ;  "kind": "calendar#events",
    ;  "etag": "\"p32cafkumkb7ta0g\"",
    ;  "summary": "support@chilkatcloud.com",
    ;  "updated": "2017-08-11T13:19:48.143Z",
    ;  "timeZone": "America/Chicago",
    ;  "accessRole": "owner",
    ;  "defaultReminders": [
    ;   {
    ;    "method": "popup",
    ;    "minutes": 10
    ;   }
    ;  ],
    ;  "nextSyncToken": "CJin09aiz9UCEJin09aiz9UCGAU=",
    ;  "items": [
    ;   {
    ;    "kind": "calendar#event",
    ;    "etag": "\"3004915160212000\"",
    ;    "id": "02pv1cpdp7vm11htnfi3ii7iie",
    ;    "status": "confirmed",
    ;    "htmlLink": "https://www.google.com/calendar/event?eid=MDJwdjFjcGRwN3ZtMTFodG5maTNpaTdpaWUgc3VwcG9ydEBjaGlsa2F0Y2xvdWQuY29t",
    ;    "created": "2017-08-11T13:19:40.000Z",
    ;    "updated": "2017-08-11T13:19:40.106Z",
    ;    "summary": "Eat Lou Malnati's Pizza",
    ;    "creator": {
    ;     "email": "support@chilkatcloud.com",
    ;     "self": true
    ;    },
    ;    "organizer": {
    ;     "email": "support@chilkatcloud.com",
    ;     "self": true
    ;    },
    ;    "start": {
    ;     "dateTime": "2017-08-12T12:00:00-05:00"
    ;    },
    ;    "end": {
    ;     "dateTime": "2017-08-12T13:00:00-05:00"
    ;    },
    ;    "iCalUID": "02pv1cpdp7vm11htnfi3ii7iie@google.com",
    ;    "sequence": 0,
    ;    "hangoutLink": "https://plus.google.com/hangouts/_/chilkatcloud.com/support?hceid=c3VwcG9ydEBjaGlsa2F0Y2xvdWQuY29t.02pv1cpdp7vm11htnfi3ii7iie",
    ;    "reminders": {
    ;     "useDefault": true
    ;    }
    ;   }
    ;  ]
    ; }
    ; 
    ; 

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sbResponse)

    numEvents.i = CkJsonObject::ckSizeOfArray(json,"items")
    i.i = 0
    While i < numEvents
        CkJsonObject::setCkI(json, i)
        Debug CkJsonObject::ckStringOf(json,"items[i].summary")
        Debug CkJsonObject::ckStringOf(json,"items[i].start.dateTime")
        Debug CkJsonObject::ckStringOf(json,"items[i].end.dateTime")
        Debug "--"
        i = i + 1
    Wend

    ; Sample output:

    ; Eat Lou Malnati's Pizza
    ; 2017-08-12T12:00:00-05:00
    ; 2017-08-12T13:00:00-05:00
    ; --


    CkJsonObject::ckDispose(jsonToken)
    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbUrl)
    CkHttpRequest::ckDispose(req)
    CkDateTime::ckDispose(dt)
    CkStringBuilder::ckDispose(sbResponse)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure