Python 2.7 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Python.
Stay organized with collections
Save and categorize content based on your preferences.
google.appengine.api.datastore_entities module
Summary
Classes for common kinds, including Contact, Message, and Event.
Most of these kinds are based on the gd namespace “kinds” from GData:
https://developers.google.com/gdata/docs/1.0/elements
Contents
- class google.appengine.api.datastore_entities.Event(title, kind=u'Event')source
-
Bases: google.appengine.api.datastore_entities.GdKind
A calendar event.
Includes the event title, description, location, organizer, start and end
time, and other details.
This is the gd Event kind. See:
https://developers.google.com/gdata/docs/1.0/elements#gdEventKind
These properties are meaningful. They are all optional.
title string event name
content string event description
author string the organizer’s name
where string* human-readable location (not a GeoPt)
startTime timestamp start time
endTime timestamp end time
eventStatus string one of the Event.Status values
link Link* page with more information
category Category* tag or label associated with this event
attendee Contact* attendees and other related people
The Contact properties should be Keys of Contact entities. They are
represented in the XML encoding as linked <gd:who> elements.
- KIND_PROPERTIES = [u'title', u'content', u'author', u'where', u'startTime', u'endTime', u'eventStatus', u'link', u'category']
- ToXml()source
-
Override GdKind.ToXml() to special-case author, gd:where, gd:when, and
gd:eventStatus.
- class google.appengine.api.datastore_entities.GdKind(kind, title, kind_properties, contact_properties=[])source
-
Bases: google.appengine.api.datastore.Entity
A base class for gd namespace kinds.
This class contains common logic for all gd namespace kinds. For example,
this class translates datastore (app id, kind, key) tuples to tag:
URIs appropriate for use in <key> tags.
- ToXml()source
-
Returns an XML representation of this entity, as a string.
- class google.appengine.api.datastore_entities.Message(title, kind=u'Message')source
-
Bases: google.appengine.api.datastore_entities.GdKind
A message, such as an email, a discussion group posting, or a comment.
Includes the message title, contents, participants, and other properties.
This is the gd Message kind. See:
https://developers.google.com/gdata/docs/1.0/elements#gdMessageKind
These properties are meaningful. They are all optional.
title string message subject
content string message body
from Contact* sender
to Contact* primary recipient
cc Contact* CC recipient
bcc Contact* BCC recipient
reply-to Contact* intended recipient of replies
link Link* attachment
category Category* tag or label associated with this message
geoPt GeoPt* geographic location the message was posted from
rating Rating* message rating, as defined by the application
The Contact properties should be Keys of Contact entities. They are
represented in the XML encoding as linked <gd:who> elements.
- KIND_PROPERTIES = [u'title', u'content', u'link', u'category', u'geoPt', u'rating']
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["\u003cp\u003eThis module defines classes for common data types like Contact, Event, and Message, based on the GData "kinds" namespace.\u003c/p\u003e\n"],["\u003cp\u003eThe Contact class represents a person, venue, or organization, with properties such as name, email, address, and phone number, mirroring the gd Contact kind.\u003c/p\u003e\n"],["\u003cp\u003eThe Event class models calendar events, including details like title, description, start and end times, organizer, and attendees, following the gd Event kind.\u003c/p\u003e\n"],["\u003cp\u003eThe Message class handles various message types, such as emails or discussion posts, and encompasses attributes like subject, body, sender, recipients, and attachments, corresponding to the gd Message kind.\u003c/p\u003e\n"],["\u003cp\u003eThe GdKind class serves as a base class for these GData namespace kinds, providing common logic and XML representation functionality.\u003c/p\u003e\n"]]],[],null,["# google.appengine.api.datastore_entities module\n==============================================\n\nSummary\n-------\n\nClasses for common kinds, including Contact, Message, and Event.\n\nMost of these kinds are based on the gd namespace \"kinds\" from GData:\n\n\n\u003chttps://developers.google.com/gdata/docs/1.0/elements\u003e\n\nContents\n--------\n\n*class* google.appengine.api.datastore_entities.Contact(title, kind=u'Contact')[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#Contact)\n\n: Bases: [google.appengine.api.datastore_entities.GdKind](#google.appengine.api.datastore_entities.GdKind)\n\n A contact: a person, a venue such as a club or a restaurant, or an\n organization.\n\n This is the gd Contact kind. See:\n \u003chttps://developers.google.com/gdata/docs/1.0/elements#gdContactKind\u003e\n\n Most of the information about the contact is in the \\\u003cgd:contactSection\\\u003e\n element; see the reference section for that element for details.\n\n These properties are meaningful. They are all optional.\n\n title string contact's name\n content string notes\n email Email\\* email address\n geoPt GeoPt\\* geographic location\n im IM\\* IM address\n phoneNumber Phonenumber\\* phone number\n postalAddress PostalAddress\\* mailing address\n link Link\\* link to more information\n category Category\\* tag or label associated with this contact\n\n - means this property may be repeated.\n\n CONTACT_SECTION_FOOTER*= u'\\\\n \\\u003c/gd:contactSection\\\u003e'*\n : \n\n CONTACT_SECTION_HEADER*= u'\\\\n \\\u003cgd:contactSection\\\u003e'*\n : \n\n CONTACT_SECTION_PROPERTIES*= \\[u'email', u'geoPt', u'im', u'phoneNumber', u'postalAddress'\\]*\n : \n\n KIND_PROPERTIES*= \\[u'title', u'content', u'link', u'category'\\]*\n : \n\n ToXml()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#Contact.ToXml)\n\n : Override GdKind.ToXml() to put some properties inside a\n gd:contactSection.\n\n*class* google.appengine.api.datastore_entities.Event(title, kind=u'Event')[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#Event)\n\n: Bases: [google.appengine.api.datastore_entities.GdKind](#google.appengine.api.datastore_entities.GdKind)\n\n A calendar event.\n\n Includes the event title, description, location, organizer, start and end\n time, and other details.\n\n This is the gd Event kind. See:\n \u003chttps://developers.google.com/gdata/docs/1.0/elements#gdEventKind\u003e\n\n These properties are meaningful. They are all optional.\n\n title string event name\n content string event description\n author string the organizer's name\n where string\\* human-readable location (not a GeoPt)\n startTime timestamp start time\n endTime timestamp end time\n eventStatus string one of the Event.Status values\n link Link\\* page with more information\n category Category\\* tag or label associated with this event\n attendee Contact\\* attendees and other related people\n\n - means this property may be repeated.\n\n The Contact properties should be Keys of Contact entities. They are\n represented in the XML encoding as linked \\\u003cgd:who\\\u003e elements. \n\n CONTACT_PROPERTIES*= \\[u'attendee'\\]*\n : \n\n KIND_PROPERTIES*= \\[u'title', u'content', u'author', u'where', u'startTime', u'endTime', u'eventStatus', u'link', u'category'\\]*\n : \n\n *class* Status[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#Event.Status)\n :\n\n CANCELED*= u'canceled'*\n :\n\n CONFIRMED*= u'confirmed'*\n :\n\n TENTATIVE*= u'tentative'*\n :\n\n ToXml()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#Event.ToXml)\n\n : Override GdKind.ToXml() to special-case author, gd:where, gd:when, and\n gd:eventStatus.\n\n*class* google.appengine.api.datastore_entities.GdKind(kind, title, kind_properties, contact_properties=\\[\\])[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#GdKind)\n\n: Bases: [google.appengine.api.datastore.Entity](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.datastore#google.appengine.api.datastore.Entity)\n\n A base class for gd namespace kinds.\n\n This class contains common logic for all gd namespace kinds. For example,\n this class translates datastore (app id, kind, key) tuples to tag:\n URIs appropriate for use in \\\u003ckey\\\u003e tags. \n\n FOOTER*= u'\\\\n\\\u003c/entry\\\u003e'*\n : \n\n HEADER*= u\"\\\u003centry xmlns:gd='http://schemas.google.com/g/2005'\\\u003e\\\\n \\\u003ccategory scheme='http://schemas.google.com/g/2005#kind'\\\\n term='http://schemas.google.com/g/2005#%s' /\\\u003e\"*\n : \n\n ToXml()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#GdKind.ToXml)\n\n : Returns an XML representation of this entity, as a string.\n\n*class* google.appengine.api.datastore_entities.Message(title, kind=u'Message')[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/datastore_entities#Message)\n\n: Bases: [google.appengine.api.datastore_entities.GdKind](#google.appengine.api.datastore_entities.GdKind)\n\n A message, such as an email, a discussion group posting, or a comment.\n\n Includes the message title, contents, participants, and other properties.\n\n This is the gd Message kind. See:\n \u003chttps://developers.google.com/gdata/docs/1.0/elements#gdMessageKind\u003e\n\n These properties are meaningful. They are all optional.\n\n title string message subject\n content string message body\n from Contact\\* sender\n to Contact\\* primary recipient\n cc Contact\\* CC recipient\n bcc Contact\\* BCC recipient\n reply-to Contact\\* intended recipient of replies\n link Link\\* attachment\n category Category\\* tag or label associated with this message\n geoPt GeoPt\\* geographic location the message was posted from\n rating Rating\\* message rating, as defined by the application\n\n - means this property may be repeated.\n\n The Contact properties should be Keys of Contact entities. They are\n represented in the XML encoding as linked \\\u003cgd:who\\\u003e elements. \n\n CONTACT_PROPERTIES*= \\[u'from', u'to', u'cc', u'bcc', u'reply-to'\\]*\n : \n\n KIND_PROPERTIES*= \\[u'title', u'content', u'link', u'category', u'geoPt', u'rating'\\]*\n :"]]