Archive for the ‘GCalendar’ Category

Restyle Google Calendar

Posted on timeApril 3rd, 2009 by userRay Baxter    flagNo Comments




Adding Events to Secondary Google Calendars in Python

Posted on timeSeptember 28th, 2008 by userRay Baxter    flag(4) Comments


Before writing, I assumed that I would need to refer any reader to the introductory post of this series on adding events to secondary calendars. Depending on your skill level and experience that may still be true, and it definitely is true if you want to understand what you are doing, but if you just want to get it done, you can probably muddle through with the following instructions.

Here’s the really short story: when you call the insertEvent method, you pass the event that you are creating and optionally, the edit url of the calendar where you want the event to appear. So, to create an event on a secondary calendar, just pass the edit link of the calendar. (You can get the edit link of a calendar in python by calling GetEditLink().href on it.)

For the longer story, I’ll assume that you have installed Python, ElementTree and the Google Data Python Library, following Google’s instructions.

Run through the tests and the sample code. When I ran the calendarExample.py it failed with this stack trace:

Traceback (most recent call last):
  File "./samples/calendar/calendarExample.py", line 577, in <module>
    main()
  File "./samples/calendar/calendarExample.py", line 574, in main
    sample.Run(delete)
  File "./samples/calendar/calendarExample.py", line 498, in Run
    self._PrintAllEventsOnDefaultCalendar()
  File "./samples/calendar/calendarExample.py", line 99, in _PrintAllEventsOnDefaultCalendar
    print '\t\t\t%s' % (a_participant.attendee_status.value,)
AttributeError: 'NoneType' object has no attribute 'value'

Since all I wanted to do was to make this sample code run for the single case of adding an event to a secondary calendar, I commented out line 99, but the code should be checking that there is an attendee status before writing its value. After that change the sample code ran fine for me.

To insert a single event in a secondary calendar, I copied calendarExample.py to secondaryCalendarInsert.py. Then I commented out everything in the Run method except this line:

503
    see = self._InsertSingleEvent()

and made the following change,

266
267
new_event = self.cal_client.InsertEvent(event, 
  '/calendar/feeds/g5b79g3f2bi5hc1it41seuu41c@group.calendar.google.com/private/full')

This instructs the InsertEvent method to create the event in my secondary calendar by POSTing to the url of my “Secondary Calendar” (id g5b79g3f2bi5hc1it41seuu41c@group.calendar.google.com) instead of my primary calendar (id default). I found the calendar ID on the calendar settings page of the calendar, but as I said above, if you have accessed a calendar programatically, you can just call GetEditLink().href on it to get the proper link.

You can see that a “One Time Tennis with Beth” event was inserted beginning at the moment I did the insert and lasting for one hour, as described in the sample code.

[Update 2008-11-14: You can't see this if you are using Safari. In general embedded calendar's show in Safari, but there is something about this particular calendar that causes it not to display. Google does a number of separate calls and redirects to obtain the correct data for this calendar and it looks like one of the calls returns data that doesn't correspond to the mime-types. The point that I was trying to communicate with this illustration was that the event did in fact appear and that it was on the secondary calendar.]

tag



Q & A – Sharing Calendars

Posted on timeSeptember 9th, 2008 by userRay Baxter    flagNo Comments


This is a little out of my normal area here, but I received this question in my email and I figured I’d answer it here for everyone’s future reference. Maybe I’ll become the next “Ask Dave“?

On Sep 9, 2008, at 9:05 AM, nadine wrote:
Dear Ray,

I do hope you don’t mind my email you… I am desperate!!!

I work for a gentleman who in turn works for 6 different companies. Because his calendar entries need to be colour coded I have obviously set up a calendar representing each different company which shows a different colour. This works fine between he and I.

However, he would like to share his calendar with a number of colleagues. Do I firstly have to ask each of his colleagues to open a Google account and then do I send an invite to them? However, I think this invites them only to his one calendar and not to all the associated company calendars?
Read the rest of this entry »

tag



Adding Events to Secondary Google Calendars

Posted on timeSeptember 1st, 2008 by userRay Baxter    flag(5) Comments


The most frequently asked question posed in the Google Calendar Date API Group is, “How do I add events to a secondary calendar?”

In this series of posts, I am going to attempt to provide an answer for using every language that has a client library. I discuss the “official” client libraries for Python, Php, .NET, Java and Javascript as well as the slightly less official Objective-C library and some of the attempts to create Ruby library for interacting with Google Calendar and GData. If there are other client libraries, just let me know in the comments and I’ll add instructions here, or link to them elsewhere as I have time, interest and understanding.

I start with describing how to POST XML to a calendar url. This is “The Protocol”. You should read this information about the protocol, even if you plan to use a client library. Each client library is using this protocol under the covers, so understanding what is happening will help you better use your client library. In addition, I’ll only explain some terms in this section, so you’ll need to read it to understand what I am talking about.

All information in these posts comes from the Google Developer’s Guides, the Client Library Documentation, the source code for the client library and my own exploration and testing. I’ll provide links to these resources in the text as appropriate. For simplicity’s sake, I only cover creating single-occurrence events for users that have properly authenticated using client login. These cases should be sufficient for illustrating how to add to secondary calendars, but 1) I’m not aware of any differences in creating single-occurrence versus quickadd or recurrent events on secondary calendars in any of the client libraries and 2) I haven’t used AuthSub.

I have personally tested all of the code that I present here, unless otherwise noted. That means that I was able to create an event on a calendar using that code. In all cases, I am adding events to my Secondary Calendar which is public, so have a look. I’ll be trying to add an event that occurs at the time when the relevant article is posted.

Here is a table of contents of the language-specific treatments. I’ll update the links as I complete the sections.

Python – Complete September 29, 2008
Php
.NET
Java
Javascript
Objective C
Ruby

Read the rest of this entry »

tag



Link Elements in GCalendar Calendar Feeds

Posted on timeMay 15th, 2008 by userRay Baxter    flagNo Comments


Here for reference is a complete listing of the rel and type attributes I have observed for link elements in Google Calendar feeds. These are a superset of the attributes contained in link elements found in event feeds. Google Calendar feeds do not use all available combinations of permitted Atom link elements. A complete list of Atom link relations is here. Atom requires that each element have a maximum of one link of each relation and type. Types are specified here for Atom elements. None of the observed relations from outside the Atom namespace have types.

link rel='alternate' type='application/atom+xml'
link rel='alternate' type='text/calendar'
link rel='alternate' type='text/html'
link rel='edit' type='application/atom+xml'
link rel='http://schemas.google.com/acl/2007#accessControlList'
link rel='http://schemas.google.com/g/2005#batch'
link rel='http://schemas.google.com/acl/2007#controlledObject'
link rel='http://schemas.google.com/g/2005#feed'
link rel='http://schemas.google.com/g/2005#post'
link rel='next' type='application/atom+xml'
link rel='previous' type='application/atom+xml'
link rel='self' type='application/atom+xml'

Notes

Alternate links point to an alternate representation of the same resource. There are three types represented in Google Calendar feeds; the type specifies that nature of the alternate representation. The application/atom+xml type alternate links are all contained inside elements and point to the individual entry. The text/html type links are to html representations of the calendar or event. The text/calendar are links to ics format calendar files.

The edit links are used to update or delete calendars or events. The post links are used to create calendars or events. The edit links are defined in the Atom Publishing Protocol. Post links are Google’s own invention.

Batch links identify the uri for posting batch request. I have no experience with batch requests, but according to the documentation insert, update, delete, or query operations are permitted.

Feed links in all observed cases are exactly the same as the id of the feed. The self links are related to the feed links and id, but also contain the (possibly implicit) url parameters that were used to retrieve the feed.

AccessControlList links identify the location of the access control list (acl) for the feed. ControlledObject links identify the feed that the acl pertains to.

Next and previous specify Atom Publishing Protocol partial collections. Next and previous are paged feeds.

tag



Persistence of gsessionids

Posted on timeMay 8th, 2008 by userRay Baxter    flagNo Comments


I’ve read this paragraph many times, but somehow the full meaning just became apparent to me.

Just like in the previous example, Calendar may return an HTTP 302 redirect; if so, then the redirect URL has a new parameter, gsessionid, appended to it. If you received the redirect, then send the same POST request again, with the same Authorization header and the same content, but with the gsessionid parameter appended. The response may also include a S cookie, which you should store and send this cookie with future requests as appropriate. Please see the knowledge base for more information on handling sessions with the Calendar data API. Please note: if a session ID indicated in a cookie header conflicts
with the session ID passed as a gsessionid URL parameter, you will get caught in a redirect loop.

The introductory clause obscures important information. Having read the previous example, I thought that there wasn’t much to be gained by reading this paragraph in detail. Just do the same thing as before, “So after you’ve sent the GET request, you have to read the HTTP headers of the response to find the URL with the session ID appended; then you need to send another GET request with that new URL.”

Really, I didn’t think too much. The gsessionid is a persistent session id. You can send it with any future request and if you do, and the session id matches the auth token your request will be accepted without redirect. Moreover you can grab the S cookie and stick it in your headers and not need to worry about it.This is documented here.

Here’s an example in action:

# get_feed is from a project I'm working on
irb:01:0> require 'get_feed'                         
=> true
# it provides an authorization method that also sets @headers and creates @http object
irb:02:0> get_auth('me@gmail.com','top_secret')      
=> {"Authorization"=>"GoogleLogin auth=DQAAAIQAAABECsmTToeu0o97DoPQ8v9lXDkqFYQY4tOC4QmkItA9jb1J2GfEql69SifsFF7TJJ6_lbAST3iuc-aZQUIvY3qDfPj4pNpo9_XAsCEphd9jRdqeqengYDnpTOEJJedw9jRV738b4x-EluyDKDPBw0f46fFDto0o8zkgY_bUChKK0T6j8A5PgedYRRJzQJm_oSY", "Content-Type"=>"application/atom+xml", "Service"=>"67central.com--get-feed-0.0.1"}
irb:03:0> @headers                                   
=> {"Authorization"=>"GoogleLogin auth=DQAAAIQAAABECsmTToeu0o97DoPQ8v9lXDkqFYQY4tOC4QmkItA9jb1J2GfEql69SifsFF7TJJ6_lbAST3iuc-aZQUIvY3qDfPj4pNpo9_XAsCEphd9jRdqeqengYDnpTOEJJedw9jRV738b4x-EluyDKDPBw0f46fFDto0o8zkgY_bUChKK0T6j8A5PgedYRRJzQJm_oSY", "Content-Type"=>"application/atom+xml", "Service"=>"67central.com--get-feed-0.0.1"}
# User's default calendar and own calendars feeds
irb:04:0> default =  '/calendar/feeds/default'          
=> "/calendar/feeds/default"
irb:05:0> all = '/calendar/feeds/default/owncalendars/full'
=> "/calendar/feeds/default/owncalendars/full"
# Request for feeds are redirected           
irb:06:0> @http.get(default,@headers)       
=> #<Net::HTTPFound 302 Moved Temporarily readbody=true>
irb:07:0> response = @http.get(all,@headers)       
=> #<Net::HTTPFound 302 Moved Temporarily readbody=true>
# All calendars feed to this location, note the gsessionid
irb:08:0> response['Location']                       
=> "https://www.google.com:443/calendar/feeds/default/owncalendars/full?gsessionid=uVGhyT0F60BtaKPNVsOeig"
# Also returns this cookie       
irb:09:0> response['set-cookie']                     
=> "S=calendar=uVGhyT0F60BtaKPNVsOeig;Expires=Fri, 08-May-2009 20:54:31 GMT"
irb:10:0> s_cookie =  response["set-cookie"].split(';').first                                                  
=> "S=calendar=uVGhyT0F60BtaKPNVsOeig"
irb:11:0> all_redirect = "/calendar/feeds/default/owncalendars/full?gsessionid=uVGhyT0F60BtaKPNVsOeig"        
=> "/calendar/feeds/default/owncalendars/full?gsessionid=uVGhyT0F60BtaKPNVsOeig"
# With the gsessionid, request succeeds    
irb:12:0> response = @http.get(all_redirect,@headers)
=> #<Net::HTTPOK 200 OK readbody=true>
irb:13:0> default_with_redirect = default + "?gsessionid=uVGhyT0F60BtaKPNVsOeig"                                        
=> "/calendar/feeds/default?gsessionid=uVGhyT0F60BtaKPNVsOeig"
# So does this one                         
irb:14:0> response = @http.get(default_with_redirect,@headers)
=> #<Net::HTTPOK 200 OK readbody=true>
# Set the cookie                        
irb:15:0> @headers['Cookie'] = s_cookie                
=> "S=calendar=uVGhyT0F60BtaKPNVsOeig"
# And both request succeed without gsessionid                     
irb:16:0> response = @http.get(all,@headers)         
=> #<Net::HTTPOK 200 OK readbody=true>
irb:17:0> response = @http.get(default,@headers)         
=> #<Net::HTTPOK 200 OK readbody=true>

I hope that is useful to some one. There is a claim in the documentation (I’ve temporarily lost it) that the API libraries will handle these session ids and cookies automatically. Good to know.

tag



Link Elements in GCalendar Event Feeds

Posted on timeApril 27th, 2008 by userRay Baxter    flagNo Comments


A question from the for the Google Calendar Data API Developer Forum.

Hi all,


for (CalendarEventEntry event : calEventList) { 
    for (Link link : event.getLinks()) { 
        System.out.println(link.getHref()); 
} 

above code fragment prints three types of links, what these are meant for?
What these links signify in the feed.

Regards,
Vijay

This is a question that I had been meaning to address, but I was planning to get to it after I addressed all the different urls that are used in the GCalendar API. Actually this question is easier and more straight-forward to answer, so it makes sense to answer this first. I’ll defer the larger questions of GCalendar event feeds and generic Atom feeds for a later post.

Here’s a complete entry feed (as formated with tidy -xml -indent):

<?xml version='1.0' encoding='utf-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:batch='http://schemas.google.com/gdata/batch'
xmlns:gCal='http://schemas.google.com/gCal/2005'
xmlns:gd='http://schemas.google.com/g/2005'>
  <id>  http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk</id>
  <published>2008-04-21T22:36:07.000Z</published>
  <updated>2008-04-21T22:36:07.000Z</updated>
  <category scheme='http://schemas.google.com/g/2005#kind'
  term='http://schemas.google.com/g/2005#event' />
  <title type='text'>Tennis with Beth</title>
  <content type='text'>Meet for a quick lesson.</content>
  <link rel='alternate' type='text/html'
  href='http://www.google.com/calendar/event?eid=ZzBwZHNqbDE4ZW05dGNkYXU2YmFxZ2F0a2sgdGQzczMyZTZrMWliN3BrZ2liaTd2NmprdGdAZw'
  title='alternate' />
  <link rel='self' type='application/atom+xml'
 href='http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk' />
  <link rel='edit' type='application/atom+xml'  href='http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk/63344500567' />
  <author>
    <name>Ray Baxter</name>
    <email>me@gmail.com</email>
  </author>
  <gd:comments>
    <gd:feedLink href='http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk/comments' />
  </gd:comments>
  <gd:eventStatus value='http://schemas.google.com/g/2005#event.confirmed' />
  <gd:visibility value='http://schemas.google.com/g/2005#event.default' />
  <gd:transparency value='http://schemas.google.com/g/2005#event.opaque' />
  <gCal:uid value='g0pdsjl18em9tcdau6baqgatkk@google.com' />
  <gCal:sequence value='0' />
  <gd:when startTime='2008-04-17T08:00:00.000-07:00'
  endTime='2008-04-17T10:00:00.000-07:00' />
  <gd:who rel='http://schemas.google.com/g/2005#event.organizer'
  valueString=''
  email='td3s32e6k1ib7pkgibi7v6jktg@group.calendar.google.com' />
  <gd:where valueString='Rolling Lawn Courts' />
</entry>

Coming to Vijay’s question, there are three elements in this feed. They are:

<link rel='alternate' type='text/html' href='http://www.google.com/calendar/event?eid=ZzBwZHNqbDE4ZW05dGNkYXU2YmFxZ2F0a2sgdGQzczMyZTZrMWliN3BrZ2liaTd2NmprdGdAZw' title='alternate' />
<link rel='self' type='application/atom+xml' href='http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk' />
<link rel='edit' type='application/atom+xml' href='http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk/63344500567' />

The links are named for their relations, i.e. the values of their rel attributes.

The first link is the alternate link, so called because it is an alternative version of the content of this event. In this case the alternate version in html format as you can see by the type='text/html' attribute. Because this calendar is public, you can click on that link and see the event in your browser. Try it.

The second link is a self link. That is the the xml feed for this event, and can repull the event from this feed (in the event that Google’s servers are working, which they don’t appear to be currently.) Notice that the http attribute of the self link is exactly the same URL as the .

<id>
http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk</id>
<link rel='self' type='application/atom+xml'
 href='http://www.google.com/calendar/feeds/td3s32e6k1ib7pkgibi7v6jktg%40group.calendar.google.com/private/full/g0pdsjl18em9tcdau6baqgatkk' />

The self link may not have been the location from you pulled the event. You might have pulled an entire calendar of events (which would have it’s own, distinct, self link) or you might have made a query for events matching some pattern and retrieved a number of events for that feed (which would ought have it’s own self link, but I haven’t verified).

Finally there is the edit link. This is the URL that you use to make changes to the event. Sending a DELETE request to this URL will delete the event. Sending a PUT request will replace event’s data with the data that you send.

For reference, the self and alternate link relations are specified as part of the Atom Syndication Format (RFC4287) and the edit relation is specified as part of the Atom Publication Protocol (RFC5023). A convenient table of all the Atom link relations is here. That table will come in handy as we examine the other link relations in GCalendar feeds.


Any other questions? Leave them in the comments and I’ll get to them as I can.

tagTags: , , , ,



Search:

Recent Posts

Categories

Relevant Links

AtomPub

Date and Time

GCalendar

GData

iCalendar Tools

Online Calendars

REST

RFCs

Timelines

Zend GData

Feeds: