معرفی
اغلب برای سرویسهایی که از Google Data API استفاده میکنند مفید است تا بتوانند مجموعهای از اطلاعات را در مورد نوع خاصی از آیتم ارائه دهند.
برای مثال، سرویسهای مختلف Google Data API (یا «GData») ممکن است اطلاعات تماس یک شخص یا یک سازمان را ارائه دهند. منطقی است که همه این خدمات از یک مجموعه از عناصر اطلاعات تماس استفاده کنند.
مجموعه عناصری که با هم یک تماس را توصیف می کنند، تماس "نوع" نامیده می شود. برخی از عناصر در نوع Contact، عناصر معمولی Atom یا RSS هستند. سایرین توسط گوگل در فضای نامی به نام "Google Data namespace" تعریف شده اند. طبق قرارداد، فضای نام Google Data معمولاً در کد XML با استفاده از gd:
alias; برای مثال، عنصری که حاوی شماره تلفن یا فکس است <gd:phoneNumber>
است. URL طرحی برای فضای نام Google Data http://schemas.google.com/g/2005 است.
Google انواع دیگری را نیز تعریف میکند: رویداد (مجموعهای از عناصر استاندارد شده که با هم یک رویداد تقویم را نشان میدهند) و پیام (مجموعهای از عناصر نشاندهنده یک پیام ایمیل، ارسال گروه بحث یا پیام دیگر).
برخی از عناصر از فضای نام Google Data با انواع مختلفی استفاده می شوند. برای مثال، عنصر <gd:who>
یک شخص را (که در <gd:who>
توضیح داده شده است) با ورودی حاوی عنصر <gd:who>
مرتبط میکند. این عنصر در نوع رویداد برای تعیین سازماندهندگان، شرکتکنندگان و غیره استفاده میشود. همچنین در نوع پیام برای تعیین فرستنده و گیرنده استفاده می شود.
وقتی ورودی در فید Google Data API از یک نوع معین استفاده میکند، حاوی یک عنصر <atom:category>
است که ویژگی scheme
آن روی "http://schemas.google.com/g/2005#kind"
و ویژگی term
آن تنظیم شده است. به نام URL طرح و سپس نام نوع تنظیم کنید. به عنوان مثال، یک ورودی تماس شامل عنصر زیر است:
<atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/>
این به مشتریان اجازه می دهد تا به سرعت و به آسانی نوع داده های ورودی را تعیین کنند - یعنی معنایی ورودی را تعیین کنند. (در صورت تمایل می توانید از RSS به جای Atom استفاده کنید؛ به سند مرجع پروتکل برای عناصر RSS مربوط به عناصر Atom مراجعه کنید.)
این سند مرجعی برای برخی از انواع رایج و عناصر موجود در آنها است.
عناصر غیر مستند
ما اطلاعاتی در مورد عناصر استاندارد <atom:entry>
در انواعی که آن عناصر معانی استاندارد خود را دارند، درج نمی کنیم. به عنوان مثال، <atom:id>
، <atom:published>
، و <atom:updated>
همگی معانی استاندارد خود را دارند که در انواع ظاهر شوند.
ما همچنین اطلاعاتی در مورد عناصر استاندارد Atom که در زمینه داده شده بیمعنی هستند، درج نمیکنیم. به عنوان مثال، <atom:summary>
در نوع Contact استفاده نمی شود، و اگرچه <atom:author>
یک عنصر ضروری در ورودی است (مگر اینکه در فید والد مشخص شده باشد)، معنای مفیدی در آن ندارد. نوع تماس
ایجاد انواع
ممکن است دشوار باشد که دقیقاً چه اطلاعاتی را باید در هنگام ایجاد یک ورودی از یک نوع خاص درج کنید، به خصوص به این دلیل که برخی از عناصر موجود در این انواع حاوی انواع دیگری هستند.
یکی از روشهایی که ممکن است کمک کند، استفاده از کتابخانههای مشتری است که ارائه میدهیم به جای تلاش برای ساخت انواع دستی. کتابخانه های مشتری روش های مختلفی را برای افزودن و تغییر داده ها در یک ورودی از یک نوع خاص ارائه می کنند. برای جزئیات به مستندات کتابخانه مشتری مراجعه کنید.
توسعه پذیری
اطلاعات موجود در این سند همه ویژگیها و مقادیر ویژگیهای ممکن را برای انواع پوشش نمیدهد. سرویسها ممکن است انواع مختلفی را گسترش دهند، بنابراین یک سرویس خاص ممکن است از ویژگیها و مقادیری استفاده کند که در این سند گنجانده نشده است.
قراردادهای تایپی
در جداول این سند، از قراردادهای زیر برای عناصر مورد نیاز و اختیاری استفاده می کنیم:
نام عنصر | عنصر مورد نیاز |
نام عنصر؟ | عنصر اختیاری |
نام عنصر* | عنصر اختیاری، چند نمونه مجاز است |
عناصر و ویژگی ها در نماد XPath استاندارد ارائه شده اند.
نوع تماس
یک مخاطب را نشان می دهد: یک شخص، یک مکان مانند یک باشگاه یا یک رستوران، یا یک سازمان.
عنصر دسته: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>
خواص
ویژگی | شرح |
---|---|
atom:category * | دسته بندی ها. نمونه هایی با ویژگی @label به عنوان برچسب در نظر گرفته می شوند. برای اطلاعات در مورد استفاده از ویژگی @scheme ، به یادداشت ابتدای این بخش مراجعه کنید. |
atom:content | نکاتی در مورد مخاطب |
atom:link * | پیوند به اطلاعات مرتبط به طور خاص، atom:link[@rel='alternate'] به یک صفحه HTML که مخاطب را توصیف می کند پیوند می دهد. |
atom:title | نام مخاطب |
gd: email * | آدرس ایمیل. |
gd: im * | آدرس های IM |
gd: phoneNumber * | شماره تلفن و فکس. |
gd: postalAddress * | آدرس های پستی |
gd: organization * | سازمان. |
gd: extendedProperty * | دارایی تمدید شده |
gContact: groupMembershipInfo * | اطلاعات عضویت در گروه |
gd: deleted * | وضعیت ورودی مخاطب حذف شد. |
مثال ها
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gd='http://schemas.google.com/g/2005'> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact'/> <title>Elizabeth Bennet</title> <content>My good friend, Liz. A little quick to judge sometimes, but nice girl.</content> <gd:email rel='http://schemas.google.com/g/2005#work' primary='true' address='liz@gmail.com'/> <gd:email rel='http://schemas.google.com/g/2005#home' address='liz@example.org'/> <gd:phoneNumber rel='http://schemas.google.com/g/2005#work' primary='true'> (206)555-1212 </gd:phoneNumber> <gd:phoneNumber rel='http://schemas.google.com/g/2005#home'> (206)555-1213 </gd:phoneNumber> <gd:phoneNumber rel='http://schemas.google.com/g/2005#mobile'> (206) 555-1212 </gd:phoneNumber> <gd:im rel='http://schemas.google.com/g/2005#home' protocol='http://schemas.google.com/g/2005#GOOGLE_TALK' address='liz@gmail.com'/> <gd:postalAddress rel='http://schemas.google.com/g/2005#work' primary='true'> 1600 Amphitheatre Pkwy Mountain View, CA 94043 </gd:postalAddress> <gd:postalAddress rel='http://schemas.google.com/g/2005#home'> 800 Main Street Mountain View, CA 94041 </gd:postalAddress> <gd:organization> <gd:orgName>Google, Inc.</gd:orgName> <gd:orgTitle>Tech Writer</gd:orgTitle> </gd:organization> </entry>
نوع رویداد
یک رویداد تقویم را نشان می دهد. مکان رویداد با یک نوع تماس که در عنصر <gd:where>
تعبیه شده (یا پیوند داده شده از) نشان داده می شود. برنامه ریزان رویداد و شرکت کنندگان به عنوان انواع تماس تعبیه شده در عناصر <gd:who>
(یا پیوند داده شده از) نشان داده می شوند.
عنصر دسته: <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/>
خواص
ویژگی | شرح |
---|---|
atom:author | شخصی که این رویداد را ایجاد کرده است. |
atom:category * | دسته بندی ها. نمونه هایی با ویژگی @label به عنوان برچسب در نظر گرفته می شوند. برای اطلاعات در مورد استفاده از ویژگی @scheme ، به یادداشت ابتدای این بخش مراجعه کنید. |
atom:content | شرح طولانی تر از رویداد. |
atom:link * | پیوندها. به طور خاص، atom:link[@rel='alternate'] پیوندی به یک صفحه HTML ارائه می دهد که رویداد را توصیف می کند. |
atom:title | عنوان مختصر رویداد |
gd: comments ؟ | فید نظرات |
gd: eventStatus ؟ | فهرست قابل توسعه مستند در زیر. |
gd: recurrence ؟ | قانون عود |
gd: transparency ؟ | فهرست قابل توسعه مستند در زیر، مربوط به ویژگی TRANSP تعریف شده در RFC 2445 است. |
gd: visibility ؟ | فهرست قابل توسعه مستند در زیر. |
gd: when * | زمان رویداد. ویژگیهای startTime و endTime باید هر دو تنظیم شوند، اگرچه برای رویدادهای تمام روز این ویژگیها فقط تاریخ هستند، بدون زمان. |
gd: when /gd:reminder * | یادآوری برای این رویداد. |
gd: where * | محل برگزاری رویداد یا ملزومات نزدیک مانند پارکینگ. اگر عنصر <gd:where> در سطح فید مشخص شده باشد، اما عنصر <gd:where> در سطح ورودی وجود نداشته باشد، ورودیها مقدار <gd:where> سطح فید را به ارث میبرند. |
gd: who * | افراد مرتبط با رویداد: برگزارکننده، شرکت کنندگان، سخنرانان، اجراکنندگان و غیره. |
gd: who /gd:attendeeStatus ? | وضعیت پذیرش |
gd: who /gd:attendeeType ? | نوع شرکت کننده: required یا optional . |
مقادیر rel برای gd:where
ارزش رابطه | شرح |
---|---|
http://schemas.google.com/g/2005#event یا مشخص نشده است. | مکانی که رویداد در آن برگزار می شود. |
http://schemas.google.com/g/2005#event.alternate | یک مکان ثانویه به عنوان مثال، یک سایت از راه دور با یک ویدیو کنفرانس به سایت اصلی پیوند می دهد. |
http://schemas.google.com/g/2005#event.parking | پارکینگ نزدیک. |
gd: مقادیر رویدادStatus
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#event.canceled | این رویداد لغو شده است. |
http://schemas.google.com/g/2005#event.confirmed | این رویداد برنامه ریزی شده است. |
http://schemas.google.com/g/2005#event.tentative | این رویداد فقط به صورت آزمایشی برنامه ریزی شده است. |
gd: مقادیر قابل مشاهده
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#event.confidential | به برخی از خوانندگان اجازه دهید رویداد را ببینند. |
http://schemas.google.com/g/2005#event.default | رفتار را از ترجیحات صاحب تقویمی که رویداد در آن ظاهر می شود به ارث ببرید. |
http://schemas.google.com/g/2005#event.private | به کمترین خوانندگان اجازه دهید رویداد را ببینند. |
http://schemas.google.com/g/2005#event.public | به اکثر خوانندگان اجازه دهید رویداد را ببینند. |
gd: مقادیر شفافیت
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#event.opaque | نشان می دهد که رویداد در تقویم زمان می برد. زمان رویداد در جستجوی آزاد/مشغول به عنوان مشغول علامتگذاری میشود. |
http://schemas.google.com/g/2005#event.transparent | نشان می دهد که رویداد هیچ زمانی در تقویم مصرف نمی کند. زمان رویداد در جستجوی آزاد/مشغول به عنوان مشغول علامت گذاری نمی شود. |
مثال ها
ملاقات:
<entry xmlns:gd="http://schemas.google.com/g/2005"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/> <id>http://mycal.example.com/feeds/jo/home/full/e1a2af06df8a563edf9d32ec9fd61e03f7f3b67b</id> <published>2005-01-18T21:00:00Z</published> <updated>2006-01-01T00:00:00Z</updated> <title>Discuss BazMat API</title> <content>We will discuss integrating GData with BazMat.</content> <author> <name>Jo March</name> <email>jo@example.com</email> </author> <gd:when startTime='2005-01-18T21:00:00Z' endTime='2005-01-18T22:00:00Z'> <gd:reminder minutes='15'/> </gd:when> <gd:where valueString='Building 41, Room X'/> <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/> <gd:visibility value="http://schemas.google.com/g/2005#event.public"/> <gd:transparency value="http://schemas.google.com/g/2005#event.transparent"/> </entry>
رویداد آنلاین:
<entry xmlns:gd="http://schemas.google.com/g/2005"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/> <id>http://mycal.example.com/feeds/jo/home/full/982307e797979879a</id> <published>2005-01-18T21:00:00Z</published> <updated>2006-01-01T00:00:00Z</updated> <title>Online Chess Tournament</title> <content/> <author> <name>Jo March</name> <email>jo@example.com</email> </author> <gd:when startTime='2006-01-24T19:00:00-08:00' endTime='2006-01-24T20:00:00-08:00'> <gd:reminder minutes='15'/> </gd:when> <gd:where> <gd:entryLink> <entry> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/> <id>http://contacts.example.com/jo/GamePhannz</id> <published>2005-01-18T21:00:00Z</published> <updated>2006-01-01T00:00:00Z</updated> <title>GamePhannz Online Game Server</title> <link rel="http://schemas.google.com/g/2005#onlineLocation" type="text/html" href="http://gamephannz.example.com/chess/138fd87e"/> <content/> </entry> </gd:entryLink> </gd:where> <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/> <gd:visibility value="http://schemas.google.com/g/2005#event.public"/> <gd:transparency value="http://schemas.google.com/g/2005#event.transparent"/> </entry>
نوع پیام
نشان دهنده یک پیام، مانند ایمیل، ارسال یک گروه بحث یا نظر است.
عنصر دسته: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message"/>
خواص
ویژگی | شرح |
---|---|
atom:category * | دسته بندی ها. نمونه هایی با ویژگی @label به عنوان برچسب در نظر گرفته می شوند. برای اطلاعات در مورد استفاده از ویژگی @scheme ، به یادداشت ابتدای این بخش مراجعه کنید. برای اطلاعات در مورد استفاده از ویژگی @term ، جدول زیر را ببینید. |
atom:content | بدنه ی پیام. |
atom:link * | پیوست های پیام به طور خاص، برای آپلود یک پیوست، از <link rel="enclosure"> استفاده کنید و محتوای پیوست را در یک مجموعه رسانه Atom قرار دهید. |
atom:title | موضوع پیام. |
gd: geoPt ? | موقعیت جغرافیایی که پیام از آن پست شده است. |
gd: rating ? | رتبه بندی کیفیت (همانطور که توسط برنامه تعریف شده است). |
gd: who * | افراد مرتبط با این پیام معنای دقیق به مقدار @rel بستگی دارد. جدول زیر را ببینید. |
مقوله @term values
همه دستههای زیر در طرح http://schemas.google.com/g/2005
قرار دارند.
مدت، اصطلاح | شرح |
---|---|
http://schemas.google.com/g/2005#message.chat | پیام متنی از یک جلسه چت است. |
http://schemas.google.com/g/2005#message.inbox | پیام به عنوان متعلق به صندوق ورودی علامت گذاری شده است. |
http://schemas.google.com/g/2005#message.sent | پیام به عنوان ارسال شده علامت گذاری می شود. |
http://schemas.google.com/g/2005#message.spam | پیام هرزنامه محسوب می شود. |
http://schemas.google.com/g/2005#message.starred | پیام به عنوان ستاره دار علامت گذاری شده است. |
http://schemas.google.com/g/2005#message.unread | پیام خوانده نشده است. |
مقادیر rel برای gd:who
ویژگی | شرح |
---|---|
http://schemas.google.com/g/2005#message.bcc | پیام گیرنده BCC. |
http://schemas.google.com/g/2005#message.cc | پیام گیرنده CC. |
http://schemas.google.com/g/2005#message.from | فرستنده پیام (ایمیل یا IM). |
http://schemas.google.com/g/2005#message.reply-to | گیرنده مورد نظر پیام پاسخ. |
http://schemas.google.com/g/2005#message.to | پیام گیرنده اصلی |
مثال
پیام ایمیل:
<entry xmlns:gd="http://schemas.google.com/g/2005"> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message"/> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message.sent"/> <author> <name>Jo March</name> <email>jo@example.com</email> </author> <id>http://mymail.example.com/feeds/jo/home/full/e1a2af06df8a563edf9d32ec9fd61e03f7f3b67b</id> <published>2006-01-18T21:00:00Z</published> <updated>2006-01-18T21:00:00Z</updated> <title>Re: Info?</title> <content>Hi, Fritz -- The information you're looking for is on p. 47.</content> <gd:who rel="http://schemas.google.com/g/2005#message.from"> <gd:entryLink href="http://contacts.example.com/jo/Jo"/> </gd:who> <gd:who rel="http://schemas.google.com/g/2005#message.to"> <gd:entryLink href="http://contacts.example.com/fritzb/FritzB"/> </gd:who> </entry>
مرجع عنصر فضای نام Google Data
بقیه این سند شامل مواد مرجع برای عناصر استفاده شده توسط انواع است.
- Enums
- gdCommonProperties
- gd: نظرات
- gd:حذف شد
- gd: ایمیل
- gd:entryLink
- gd:extendedProperty
- gd:feedLink
- gd:geoPt
- gd:im
- gd: سازمان
- gd:orgName
- gd:orgTitle
- gd:originalEvent
- gd: شماره تلفن
- gd:postalAddress
- gd: رتبه بندی
- gd:عود
- gd:recurenceException
- gd: یادآوری
- gd: وقتی
- gd: کجا
- gd: چه کسی
Enums
برخی از عناصر پسوند نیاز به مشخص کردن ویژگی هایی دارند که مقادیر آنها از یک مجموعه شمارش شده آمده است. شکل کلی چنین خواصی به شرح زیر است:
<gd:propertyName value="propertyValue">
اگر مقدار ویژگی از فضای نام Google Data باشد، به شکل http://schemas.google.com/g/2005#
{kind} است .
{ارزش}. به عنوان مثال: http://schemas.google.com/g/2005#event.tentative
. اگر فضای مقدار قابل گسترش باشد، مقادیر ممکن است به شکل URI نیز باشند. فرم توصیه شده برای URI های با ارزش توسعه یافته {schema URI} #
{value} است. به عنوان مثال: http://www.example.com/attendeeStatus#AudioConference
.
gEnumConstruct = attribute value { text }, anyAttribute*
gdCommonProperties
ویژگی های رایج مورد استفاده برای همه انواع Google. توجه داشته باشید که وجود anyAttribute
و anyElement
در طرحواره به همه عناصر فضای نام Google Data با استفاده از ویژگیهای رایج اجازه میدهد تا در هر فضای نامی گسترش بیشتری پیدا کنند. به طور خاص، قرار دادن هر عنصر gd یا هر عنصر Atom/RSS در هر عنصر gd دیگر قانونی است. این باید با احتیاط انجام شود، و در بیشتر موارد چنین استفاده ای باید به عنوان یک ویژگی صریح از نوع عنصر حاوی gd مستند شود.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@xml:base | uri | ساختار استاندارد XML برای توصیف پایه URI های نسبی تو در تو. |
@xml:lang | text | زبان رشته های تو در تو |
طرحواره
namespace gd = "http://schemas.google.com/g/2005" gdCommonProperties = { atomCommonAttributes, anyAttribute*, (anyElement*) }
gd: نظرات
حاوی فید نظرات برای ورودی محصور (مانند یک رویداد تقویم).
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@rel ? | string | نوع نظرات موجود در در حال حاضر، بین نظرات معمولی و نقدها تفاوت وجود دارد. |
gd: feedLink ? | feedLink | فید نظرات این فید باید نوع Message را اجرا کند. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#regular یا مشخص نشده است | نظرات منظم (از کاربران). |
http://schemas.google.com/g/2005#reviews | بررسی های حرفه ای |
مثال ها
خوراک نظرات:
<gd:comments> <gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10"> <feed> <id>http://example.com/Jo/posts/MyFirstPost/comments</id> <title>My first post: comments</title> ... <entry> ... <content>Good post.</content> </entry> <entry> ... </entry> ... </feed> </gd:feedLink> </gd:comments>
فید نظرات:
<gd:comments rel="http://schemas.google.com/g/2005#reviews"> <gd:feedLink href="http://example.com/restaurants/SanFrancisco/432432/reviews" countHint="25"> <feed> <id>http://example.com/restaurants/SanFrancisco/432432/reviews</id> <title>La Folie reviews</title> ... <entry> ... <content>Good food.</content> <gd:rating value="5" min="1" max="5"/> </entry> <entry> ... </entry> ... </feed> </gd:feedLink> </gd:comments>
طرحواره
start = comments comments = element gd:comments { gdCommonProperties, attribute rel { xs:string }?, (feedLink?) }
gd:حذف شد
یک عنصر نشانگر که در صورت وجود، نشان می دهد ورودی حاوی حذف شده است.
خواص
هیچ یک.
طرحواره
start = deleted deleted = element gd:deleted
gd: ایمیل
یک آدرس ایمیل مرتبط با موجودیت حاوی (که معمولاً نهادی است که نماینده یک شخص یا یک مکان است).
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@address | xs:string | آدرس ایمیل. |
@label ? | xs:string | یک مقدار رشته ساده برای نامگذاری این آدرس ایمیل استفاده می شود. این به UI ها اجازه می دهد برچسب هایی مانند "Work"، "Personal"، "Preferred" و غیره را نمایش دهند. |
@rel ? | xs:string | یک مقدار برنامه ای که نوع ایمیل را مشخص می کند. برای جزئیات به زیر مراجعه کنید |
@primary ؟ | xs:boolean | هنگامی که چندین پسوند ایمیل در یک نوع مخاطب ظاهر می شود، نشان می دهد که کدام یک اصلی است. حداکثر یک ایمیل ممکن است اصلی باشد. مقدار پیش فرض "false" است. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#home | |
http://schemas.google.com/g/2005#other | آدرس ایمیلی که نه خانه است و نه محل کار. label می تواند برای نشان دادن نوع واقعی استفاده شود. |
http://schemas.google.com/g/2005#work |
مثال ها
<gd:email address="foo@bar.example.com"/> <gd:email label="Personal" rel="http://schemas.google.com/g/2005#home" address="fubar@gmail.com" primary="true"/>
طرحواره
start = email email = element gd:email { attribute address { xs:string }, attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }? }
gd:entryLink
یک ورودی منطقی تو در تو را نشان می دهد. برای مثال، یک <gd:who>
که یک مخاطب را نشان میدهد ممکن است یک ورودی تودرتو از فید مخاطب داشته باشد.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@href ? | xs:string | URI ورودی را مشخص می کند. اگر ورودی تودرتو تعبیه شده باشد و پیوند داده نشده باشد، این ویژگی ممکن است حذف شود. |
@readOnly ? | xs:boolean | مشخص می کند که آیا ورودی موجود فقط خواندنی است یا خیر. مقدار پیش فرض "false" است. |
@rel ? | xs:string | رابطه پیوند را مشخص می کند. به سرویس اجازه می دهد تا چندین نوع پیوند ورودی برای یک موجودیت واحد ارائه دهد. دارای همان معنای و مقادیر مجاز با ویژگی rel عنصر <atom:link> . |
atom:entry ? | atomEntry | محتویات مدخل. |
محدودیت های
- یکی یا هر دو
@href
یا<atom:entry>
باید وجود داشته باشد. - اگر
atom:entry
وجود نداشته باشد، مشتری میتواند محتویات را از URI ورودی در@href
دریافت کند. اگرatom:entry
وجود داشته باشد، محتویات باید همان محتوایی باشد که در زمان ایجاد ورودی از@href
بازیابی میشود. - هنگامی که یک
PUT
یا یکPOST
حاوی یک<gd:entryLink>
باشد و صفت@href
مشخص شود، از مقدار مشخصه برای ایجاد یک پیوند استفاده می شود. اگر عنصرatom:entry
نیز وجود داشته باشد، نادیده گرفته می شود. اگر صفت@href
مشخص نشده باشد، عنصرatom:entry
یا به عنوان یک ورودی جاسازی شده ذخیره می شود یا در فید دیگری ذخیره می شود و به آن پیوند داده می شود. توجه داشته باشید که برخی از سرویس ها ممکن است از همه این گزینه ها پشتیبانی نکنند.
مثال ها
اطلاعات تماس در <gd:who>
:
<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo"> <gd:entryLink href="http://gmail.com/jo/contacts/Jo"> <entry> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/> <id>http://gmail.com/jo/contacts/Jo</id> <category term="user-tag" label="Google"/> <title>Jo March</title> <gd:email address="jo@example.com"/> <gd:phoneNumber label="work">(650) 555-1212</gd:phoneNumber> </entry> </gd:entryLink> </gd:who>
فقط مرجع خارجی (ورودی فقط خواندنی):
<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo"> <gd:entryLink href="http://gmail.com/jo/contacts/Jo" readOnly="true"/> </gd:who>
طرحواره
start = entryLink entryLink = element gd:entryLink { attribute href { xs:string }?, attribute readOnly { xs:boolean }?, (atomEntry?) }
gd:extendedProperty
به شما امکان می دهد مقدار محدودی از داده های سفارشی را به عنوان یک ویژگی کمکی موجودیت محصور کننده ذخیره کنید.
توجه داشته باشید که وجود anyForeignElement
به فید اجازه می دهد تا به صورت اختیاری هر XML معتبری را در عنصر gd:extendedProperty
تعبیه کند (متقابل با ویژگی value
).
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@name | xs:string | نام دارایی را که به صورت URI بیان شده است را مشخص می کند. URIهای دارایی توسعه یافته معمولاً از قرارداد {scheme}#{local-name} پیروی می کنند. |
@value ؟ | xs:string | ارزش ملک. |
مثال
یک شناسه خارجی برای یک رویداد تقویم:
<gd:extendedProperty name="http://www.example.com/schemas/2007#mycal.id" value="1234"></gd:extendedProperty>
xml اضافی برای ورود مخاطب
<gd:extendedProperty name="com.google"> <some_xml>value</some_xml> </gd:extendedProperty>
طرحواره
start = extendedProperty extendedProperty = element gd:extendedProperty { attribute name { xs:string }, attribute value { xs:string } ?, (anyForeignElement*) }
gd:feedLink
نشان دهنده یک خوراک تودرتو منطقی است. به عنوان مثال، یک فید تقویم ممکن است یک فید تودرتو داشته باشد که تمام نظرات ورودیها را نشان میدهد.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@countHint ? | xs:unsignedInt | نکاتی در مورد تعداد ورودی ها در فید. بسته به اجرا، ممکن است شمارش دقیقی نباشد. |
@href ? | xs:string | URI فید را مشخص می کند. اگر فید تودرتو تعبیه شده باشد و پیوند داده نشده باشد، این ویژگی ممکن است حذف شود. |
@readOnly ? | xs:boolean | مشخص می کند که آیا فید موجود فقط خواندنی است یا خیر. |
@rel ? | xs:string | رابطه پیوند را مشخص می کند. به این سرویس اجازه می دهد تا چندین نوع پیوند فید را برای یک موجودیت واحد فراهم کند. دارای همان معنای و مقادیر مجاز با ویژگی rel عنصر <atom:link> . |
atom:feed ؟ | atomFeed | محتویات خوراک. |
محدودیت های
- یکی یا هر دو
@href
یا<atom:feed>
باید وجود داشته باشد. - اگر
atom:feed
وجود نداشته باشد، مشتری میتواند محتویات را از URI در@href
دریافت کند. اگر وجود داشته باشد، محتویات باید همان محتوایی باشد که در زمان تولید فید از@href
بازیابی میشود. - هنگامی که یک PUT یا یک POST حاوی یک
<gd:feedLink>
باشد و صفت@href
مشخص شود، از مقدار مشخصه برای ایجاد یک پیوند استفاده می شود. اگر عنصر<atom:feed>
نیز وجود داشته باشد، نادیده گرفته می شود. اگر صفت@href
مشخص نشده باشد، عنصر<atom:feed>
به عنوان یک فید تعبیه شده ذخیره می شود. توجه داشته باشید که برخی از سرویس ها ممکن است از همه این گزینه ها پشتیبانی نکنند.
مثال ها
وبلاگ نویسی:
<gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10"> <feed> <id>http://example.com/Jo/posts/MyFirstPost/comments</id> <title>My first post: comments</title> ... <entry> ... <content>Good post.</content> </entry> <entry> ... </entry> ... </feed> </gd:feedLink>
فقط مرجع خارجی:
<gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10"/>
فید تعبیه شده در ورودی Atom که یک لیست را نشان می دهد:
<gd:feedLink> <feed> <id>cid:1</id> <entry> <id>cid:1.1</id> <content>list item 1</content> </entry> <entry> <id>cid:1.2</id> <content>list item 2</content> </entry> </feed> </gd:feedLink>
طرحواره
start = feedLink feedLink = element gd:feedLink { attribute href { xs:string }?, attribute readOnly { xs:boolean }?, attribute countHint { xs:unsignedInt }?, (atomFeed?) }
gd:geoPt
موقعیت جغرافیایی (طول جغرافیایی، طول جغرافیایی، ارتفاع).
منسوخ. این عنصر منسوخ شده است. برای برچسب گذاری جغرافیایی داده ها، به جای آن از GeoRSS استفاده کنید.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@elev ? | xs:float | ارتفاع بر حسب متر مقادیر منفی اعماق کمتر از میانگین سطح دریا را نشان می دهد. |
@label ? | xs:string | یک مقدار رشته ساده برای نامگذاری این مکان استفاده می شود. این به UI ها اجازه می دهد تا برچسبی مانند "موقعیت فعلی" را نمایش دهند. |
@lat | xs:float | عرض جغرافیایی بر حسب درجه مقادیر مثبت به معنای شمال، مقادیر منفی به معنای جنوب است. محدوده [90.0-، 90.0] است. |
@lon | xs:float | طول جغرافیایی بر حسب درجه ارزش های مثبت یعنی شرق، ارزش های منفی یعنی غرب. محدوده [-180.0، 180.0] است. |
@time ؟ | xs:dateTime | مهر زمان. |
مثال ها
<gd:geoPt lat="40.75" lon="-74.0"/>
<gd:geoPt lat="27.98778" lon="86.94444" elev="8850.0"/>
طرحواره
start = geoPt geoPt = element gd:geoPt { attribute label { xs:string }?, attribute lat { xs:float }, attribute lon { xs:float }, attribute elev { xs:float }?, attribute time { xs:dateTime }? }
gd:im
یک آدرس پیام فوری مرتبط با موجودیت حاوی.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@address | xs:string | آدرس IM |
@label ? | xs:string | یک مقدار رشته ساده برای نامگذاری این آدرس IM استفاده می شود. این به UI ها اجازه می دهد برچسب هایی مانند "Work"، "Personal"، "Preferred" و غیره را نمایش دهند. |
@rel ? | xs:string | یک مقدار برنامه ای که نوع IM را مشخص می کند. برای جزئیات به زیر مراجعه کنید |
@protocol ؟ | xs:string | شبکه IM را شناسایی می کند. مقدار ممکن است یکی از مقادیر استاندارد (نشان داده شده در زیر) یا یک URI باشد که یک شبکه IM اختصاصی را شناسایی می کند. |
@primary ؟ | xs:boolean | هنگامی که چندین برنامه افزودنی IM در یک نوع مخاطب ظاهر می شود، نشان می دهد که کدام اصلی است. حداکثر یک پیام فوری ممکن است اولیه باشد. مقدار پیش فرض "false" است. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#home | |
http://schemas.google.com/g/2005#other | یک آدرس IM که نه خانه است و نه محل کار. label می تواند برای نشان دادن نوع واقعی استفاده شود. |
http://schemas.google.com/g/2005#work |
مقادیر ویژگی پروتکل
جدول زیر برخی از مقادیر احتمالی ممکن برای ویژگی @protocol را نشان می دهد.
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#AIM | پروتکل AOL Instant Messenger |
http://schemas.google.com/g/2005#MSN | پروتکل MSN Messenger |
http://schemas.google.com/g/2005#YAHOO | پروتکل یاهو مسنجر |
http://schemas.google.com/g/2005#SKYPE | پروتکل اسکایپ |
http://schemas.google.com/g/2005#QQ | پروتکل QQ |
http://schemas.google.com/g/2005#GOOGLE_TALK | پروتکل Google Talk |
http://schemas.google.com/g/2005#ICQ | پروتکل ICQ |
http://schemas.google.com/g/2005#JABBER | پروتکل جابر |
مثال ها
یک آدرس IM برای MSN Messenger:
<gd:im protocol="http://schemas.google.com/g/2005#MSN" address="foo@bar.msn.com" rel="http://schemas.google.com/g/2005#home" primary="true"/>
یک آدرس IM ارائه شده توسط کاربر با یک پروتکل نامشخص. چنین آدرسی برای اهداف نمایشی مفید است، اما مدیریت آن از نظر برنامهریزی دشوار است.
<gd:im label="Other" address="foo@baz.example.com"/>
طرحواره
start = im im = element gd:im { attribute address { xs:string }, attribute label { xs:string }?, attribute rel { xs:string }?, attribute protocol { xs:string }?, attribute primary { xs:boolean }? }
gd: سازمان
سازمانی که معمولاً با یک مخاطب مرتبط است.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@label ? | xs:string | یک مقدار رشته ای ساده برای نامگذاری این سازمان استفاده می شود. این به UI ها اجازه می دهد برچسب هایی مانند "کار"، "داوطلب"، "جامعه حرفه ای" و غیره را نمایش دهند. |
@rel ? | xs:string | یک مقدار برنامه ای که نوع سازمان را مشخص می کند. |
@primary ؟ | xs:boolean | وقتی چندین برنامه افزودنی سازمان در یک نوع تماس ظاهر میشوند، نشان میدهد که کدام اصلی است. حداکثر یک سازمان ممکن است اولیه باشد. مقدار پیش فرض "false" است. |
gd:orgName ? | orgName | نام سازمان. |
gd:orgTitle ? | orgTitle | عنوان یک شخص در سازمان. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#other | سازمانی که کار نمی کند. label می تواند برای نشان دادن نوع واقعی استفاده شود. |
http://schemas.google.com/g/2005#work |
مثال ها
<gd:organization rel="http://schemas.google.com/g/2005#work" label="Work" primary="true"/> <gd:orgName>Google, Inc.</gd:orgName> <gd:orgTitle>Tech Writer</gd:orgTitle> </gd:organization>
طرحواره
start = organzation organization = element gd:organization { attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }? orgName?, orgTitle?, }
gd:orgName
نام سازمان. باید در یک عنصر gd:organization
ظاهر شود.
مثال
<gd:orgName>Google, Inc.</gd:orgName>
طرحواره
start = orgName orgName = element gd:orgName { xs:string }
gd:orgTitle
عنوان یک شخص در یک سازمان. باید در یک عنصر gd:organization
ظاهر شود.
مثال
<gd:orgTitle>President and CEO</gd:orgTitle>
طرحواره
start = orgTitle orgTitle = element gd:orgTitle { xs:string }
gd:originalEvent
معادل ویژگی Recurrence ID مشخص شده در بخش 4.8.4.4 RFC 2445 . برای شناسایی رویداد اصلی در هر نمونه از یک رویداد تکرار شونده ظاهر می شود.
حاوی یک عنصر <gd:when>
است که زمان شروع اولیه نمونه ای را که به یک استثنا تبدیل شده است را مشخص می کند.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@id | xs:string | شناسه رویداد برای رویداد اصلی. |
@href | xs:string | نشانی وب فید رویداد برای رویداد اصلی. |
مثال
تعیین یک رویداد اصلی:
<gd:originalEvent id="i8fl1nrv2bl57c1qgr3f0onmgg" href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID"> <gd:when startTime="2006-03-17T22:00:00.000Z"/>
</gd:originalEvent>
طرحواره
start = originalEvent originalEvent = element gd:originalEvent { attribute id { xs:string }, attribute href { xs:string }, when }
gd: شماره تلفن
شماره تلفن مرتبط با موجودیت حاوی (که معمولاً نهادی است که نماینده یک شخص یا یک مکان است).
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@label ? | xs:string | یک مقدار رشته ای ساده برای نامگذاری این شماره تلفن استفاده می شود. در اکثر موارد، @label ضروری نیست، زیرا @rel به طور منحصربهفرد یک عدد را شناسایی میکند و به رابطهای کاربری اجازه میدهد برچسب مناسبی مانند "Mobile"، "Home"، "Work" و غیره را نمایش دهند. اما در مواردی که یک نفر دارای ( به عنوان مثال) چندین تلفن همراه، از این ویژگی می توان برای رفع ابهام آنها استفاده کرد. |
@rel ? | xs:string | یک مقدار برنامه ای که نوع شماره تلفن را مشخص می کند. برای جزئیات به زیر مراجعه کنید |
@uri ? | xs:string | یک "tel URI" اختیاری که برای نشان دادن شماره به صورت رسمی استفاده می شود، برای دسترسی برنامه ریزی شده، مانند پل VoIP/PSTN مفید است. برای اطلاعات بیشتر در مورد تلفن URI به RFC 3966 مراجعه کنید. |
@primary ؟ | xs:boolean | وقتی چندین پسوند شماره تلفن در یک نوع مخاطب ظاهر میشوند، نشان میدهد که کدام یک اصلی است. حداکثر یک شماره تلفن ممکن است اصلی باشد. مقدار پیش فرض "false" است. |
text() | xs:string | شماره تلفن قابل خواندن توسط انسان؛ ممکن است در هر قالب شماره تلفن باشد. فضای سفید پیشرو و دنباله دار ناچیز است. خطوط جدید درون رشته نیز ناچیز هستند و ممکن است حذف شوند یا به یک فضای منفرد تبدیل شوند. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#fax | |
http://schemas.google.com/g/2005#home | |
http://schemas.google.com/g/2005#home_fax | |
http://schemas.google.com/g/2005#mobile | |
http://schemas.google.com/g/2005#other | نوع خاصی از عدد که هیچ مقدار rel دیگری برای آن معنا ندارد. به عنوان مثال، یک دستگاه TTY. label می تواند برای نشان دادن نوع واقعی استفاده شود. |
http://schemas.google.com/g/2005#pager | |
http://schemas.google.com/g/2005#work | |
http://schemas.google.com/g/2005#work_fax |
مثال ها
شماره تلفن ساده وارد شده توسط کاربر:
<gd:phoneNumber>(425) 555-8080 ext. 72585</gd:phoneNumber>
همان شماره تلفن گرفته شده از یک فهرست:
<gd:phoneNumber rel="http://schemas.google.com/g/2005#work" uri="tel:+1-425-555-8080;ext=52585"> (425) 555-8080 ext. 52585 </gd:phoneNumber>
شماره با برچسب:
<gd:phoneNumber rel="http://schemas.google.com/g/2005#mobile" label="Personal calls only" uri="tel:+12065551212"> +1 206 555 1212 </gd:phoneNumber>
طرحواره
start = phoneNumber phoneNumber = element gd:phoneNumber { attribute rel { xs:string }?, attribute label { xs:string }?, attribute uri { xs:string }?, attribute primary { xs:boolean }?, (xs:string) }
gd:postalAddress
یک آدرس پستی
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@label ? | xs:string | یک مقدار رشته ساده برای نامگذاری این آدرس استفاده می شود. |
@rel ? | xs:string | یک مقدار برنامهای که نوع آدرس پستی را مشخص میکند. برای جزئیات به زیر مراجعه کنید |
@primary ؟ | xs:boolean | هنگامی که چندین پسوند آدرس پستی در یک نوع مخاطب ظاهر می شود، نشان می دهد که کدام یک اصلی است. حداکثر یک آدرس پستی ممکن است اصلی باشد. مقدار پیش فرض "false" است. |
text() | xs:string | آدرس به عنوان متن فضای سفید پیشرو و دنباله دار ناچیز است. خطوط جدید در رشته مهم هستند. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#home | |
http://schemas.google.com/g/2005#other | آدرسی که نه خانه است و نه محل کار. label می تواند برای نشان دادن نوع واقعی استفاده شود. |
http://schemas.google.com/g/2005#work |
مثال ها
<gd:postalAddress> 500 West 45th Street New York, NY 10036 </gd:postalAddress>
طرحواره
start = postalAddress postalAddress = element gd:postalAddress { attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }?, (xs:string) }
gd: رتبه بندی
نشاندهنده رتبهبندی عددی موجودیت دربرگیرنده، مانند یک نظر. هر رتبه بندی مقیاس مخصوص به خود را ارائه می کند، اگرچه ممکن است توسط یک سرویس عادی شود. برای مثال، برخی از سرویسها ممکن است همه رتبهبندیها را به مقیاسی از 1 تا 5 تبدیل کنند.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@average ؟ | xs:float | میانگین امتیاز. |
@max | xs:int | حداکثر مقدار مقیاس رتبه بندی. |
@min | xs:int | حداقل مقدار مقیاس رتبه بندی |
@numRaters ? | xs:int | تعداد رتبه هایی که هنگام محاسبه مقدار متوسط در نظر گرفته شده است. |
@rel ? | xs:string | جنبه ای را که در حال رتبه بندی است مشخص می کند. اگر مشخص نشده باشد، رتبه یک رتبه بندی کلی است. |
@value ؟ | xs:int | ارزش رتبه بندی |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#overall یا مشخص نشده است | امتیاز کلی. مقادیر بالاتر به معنای رتبه بندی بهتر است. |
http://schemas.google.com/g/2005#price | رتبه بندی قیمت. ارزش های بالاتر به معنای قیمت های بالاتر است. |
http://schemas.google.com/g/2005#quality | رتبه بندی کیفیت. ارزش های بالاتر به معنای کیفیت بهتر است. |
مثال ها
امتیاز کلی 4/5:
<gd:rating value="4" min="1" max="5"/>
گران ترین رتبه بندی محدوده قیمت:
<gd:rating rel="http://schemas.google.com/g/2005#price" value="5" min="1" max="5"/>
دارای امتیاز 200 کاربر با میانگین امتیاز 4.65 از 5:
<gd:rating average="4.65" min="1" max="5" numRaters="200"/>
طرحواره
start = rating rating = element gd:rating { gdCommonProperties, attribute rel { xs:string }?, attribute value { xs:int }?, attribute average { xs:float }?, attribute min { xs:int }, attribute max { xs:int }, attribute numRaters { xs:int }? }
gd:عود
نشان دهنده تاریخ ها و زمان هایی است که یک رویداد تکراری رخ می دهد.
رشته ای که تکرار را تعریف می کند از مجموعه ای از ویژگی ها تشکیل شده است که هر کدام در استاندارد iCalendar (RFC 2445) تعریف شده اند.
به طور خاص، رشته معمولاً با یک ویژگی DTSTART شروع می شود که زمان شروع اولین نمونه رویداد را نشان می دهد، و اغلب یک ویژگی DTEND یا یک ویژگی DURATION برای نشان دادن زمان پایان اولین نمونه شروع می شود. بعد ویژگی های RRULE، RDATE، EXRULE و/یا EXDATE می آیند که در مجموع یک رویداد تکرار شونده و استثناهای آن را تعریف می کنند (اما به زیر مراجعه کنید). (برای اطلاعات بیشتر در مورد این ویژگیهای مؤلفه تکراری، به بخش 4.8.5 RFC 2445 مراجعه کنید.) در آخر یک مؤلفه VTIMEZONE آمده است که قوانین دقیق منطقه زمانی را برای هر شناسه منطقه زمانی ذکر شده در ویژگیهای قبلی ارائه میکند.
سرویسهای Google مانند Google Calendar معمولاً ویژگیهای EXRULE و EXDATE را برای نمایش استثنائات رویدادهای تکرارشونده ایجاد نمیکنند. در عوض، عناصر <gd:recurrenceException>
را تولید می کنند. با این حال، خدمات Google ممکن است به هر حال دارای ویژگی های EXRULE و/یا EXDATE باشد. برای مثال، کاربران میتوانند رویدادها و استثناها را به تقویم وارد کنند، و اگر آن رویدادهای وارد شده حاوی ویژگیهای EXRULE یا EXDATE باشند، تقویم زمانی که عنصر <gd:recurrence>
ارسال میکند، آن ویژگیها را ارائه میکند.
توجه داشته باشید که استفاده از <gd:recurrenceException>
به این معنی است که شما نمی توانید فقط با بررسی یک عنصر <gd:recurrence>
مطمئن شوید که آیا هیچ استثنایی برای شرح تکرار وجود دارد یا خیر. برای اطمینان از یافتن همه استثناها، عناصر <gd:recurrenceException>
را در فید جستجو کنید و از عناصر <gd:originalEvent>
آنها استفاده کنید تا آنها را با عناصر <gd:recurrence>
مطابقت دهید.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
text() | xs:string | شرح عود |
مثال
یک رویداد تکراری که هر روز صبح از ساعت 6:00 تا 7:00 صبح، به وقت اقیانوس آرام، از 14 مارس تا 21 مارس 2006 برگزار می شود:
<gd:recurrence> DTSTART;TZID=America/Los_Angeles:20060314T060000 DURATION:PT3600S RRULE:FREQ=DAILY;UNTIL=20060321T220000Z BEGIN:VTIMEZONE TZID:America/Los_Angeles X-LIC-LOCATION:America/Los_Angeles BEGIN:STANDARD TZOFFSETFROM:-0700 TZOFFSETTO:-0800 TZNAME:PST DTSTART:19671029T020000 RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU END:STANDARD BEGIN:DAYLIGHT TZOFFSETFROM:-0800 TZOFFSETTO:-0700 TZNAME:PDT DTSTART:19870405T020000 RRULE:FREQ=YEARLY;BYMONTH=4;BYDAY=1SU END:DAYLIGHT END:VTIMEZONE </gd:recurrence>
طرحواره
start = recurrence recurrence = element gd:recurrence { (xs:string) }
gd:recurenceException
رویدادی را نشان میدهد که یک استثنا برای یک رویداد تکراری است - یعنی نمونهای از یک رویداد تکرارشونده که در آن یک یا چند جنبه از رویداد تکرارشونده (مانند فهرست حضور، زمان یا مکان) تغییر کرده است.
حاوی یک عنصر <gd:originalEvent>
است که رویداد تکرار شونده اصلی را مشخص می کند که این رویداد از آن استثنا است.
وقتی نمونه ای از یک رویداد تکراری را تغییر می دهید، آن نمونه به یک استثنا تبدیل می شود. بسته به اینکه چه تغییری در آن ایجاد کردهاید، وقتی رویداد تکرارشونده اصلی تغییر میکند، استثنا به یکی از دو روش متفاوت رفتار میکند:
- اگر نظرات، شرکتکنندگان یا پاسخهای شرکتکنندگان را اضافه کنید، تغییر دهید یا حذف کنید، این استثنا همچنان با رویداد اصلی مرتبط میماند و تغییرات رویداد اصلی، استثنا را نیز تغییر میدهد.
- اگر هر گونه تغییر دیگری در استثنا ایجاد کنید (مانند تغییر زمان یا مکان)، نمونه «تخصصی» میشود، به این معنی که دیگر به رویداد اصلی مرتبط نیست. اگر رویداد اصلی را تغییر دهید، استثناهای تخصصی تغییر نمیکنند. اما زیر را ببینید.
به عنوان مثال، فرض کنید هر سهشنبه و پنجشنبه ساعت ۲ بعد از ظهر جلسه دارید، اگر فهرست حضور را برای جلسه پنجشنبهای تغییر دهید (اما نه برای جلسهای که به طور منظم برنامهریزی شده است)، در این صورت استثنا میشود. اگر زمان جلسه این پنجشنبه را تغییر دهید (اما نه برای جلسه برنامه ریزی شده منظم)، آنگاه تخصصی می شود.
صرف نظر از تخصصی بودن یا نبودن یک استثنا، اگر کاری انجام دهید که نمونه ای را که استثنا از آن مشتق شده است حذف کنید، آن استثنا حذف می شود. توجه داشته باشید که تغییر روز یا ساعت یک رویداد تکراری، همه نمونهها را حذف میکند و موارد جدید ایجاد میکند.
به عنوان مثال، بعد از اینکه جلسه این پنج شنبه را تخصصی کردید، بگویید که جلسه تکراری را در روزهای دوشنبه، چهارشنبه و جمعه تغییر داده اید. این تغییر همه موارد تکراری جلسه سه شنبه/پنجشنبه، از جمله موارد تخصصی را حذف می کند.
اگر نمونه خاصی از یک رویداد تکرارشونده حذف شود، آن نمونه به صورت یک <gd:recurrenceException>
نشان داده می شود که حاوی <gd:entryLink>
است که <gd:eventStatus>
آن را روی "http://schemas.google.com/g/2005#event.canceled"
تنظیم کرده است." "http://schemas.google.com/g/2005#event.canceled"
. (برای اطلاعات بیشتر در مورد رویدادهای لغو شده، به RFC 2445 مراجعه کنید.)
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@specialized | xs:boolean | نشان می دهد که آیا استثنا تخصصی است یا خیر. |
gd:entryLink | entryLink | یک ورودی رویداد که جزئیات مربوط به استثنا را ارائه می دهد. |
gd:originalEvent | originalEvent | رویداد تکرار شونده اصلی که این یک استثنا است. |
مثال
یک استثنا برای یک رویداد تکرار شونده (با برخی از قطعات جایگزین شده با شناسه های مورب مختصر برای وضوح):
<gd:recurrenceException specialized="true"> <gd:entryLink> <entry> <id>i8fl1nrv2bl57c1qgr3f0onmgg_20060317T220000Z</id> <published>2006-03-17T23:00:00.000Z</published> <updated>2006-03-14T21:33:12.000Z</updated> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/> <title type="text">recurrence</title> <content type="text"/> <link rel="alternate" type="text/html" href="http://www.google.com/calendar/event?eid=idString" title="alternate"/> <author> <name>exception</name> </author> <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/> <gd:comments> <gd:feedLink href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID/comments/"> <feed> <updated>2006-03-14T21:36:23.250Z</updated> <title type="text">Comments for: recurrence</title> <link rel="alternate" type="text/html" href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID/comments/" title="alternate"/> </feed> </gd:feedLink> </gd:comments> <gd:transparency value="http://schemas.google.com/g/2005#event.opaque "/> <gd:originalEvent id="i8fl1nrv2bl57c1qgr3f0onmgg" href="http://www.google.com/calendar/feeds/userID/private-magicCookie/composite/eventID"> <gd:when startTime="2006-03-17T22:00:00.000Z"/> </gd:originalEvent> <gd:where valueString="Home"/> <gd:when startTime="2006-03-17T23:00:00.000Z" endTime="2006-03-18T00:00:00.000Z"/> </entry> </gd:entryLink> </gd:recurrenceException>
طرحواره
start = recurrenceException recurrenceException = element gd:recurrenceException { attribute specialized { xs:boolean }, (entryLink & originalEvent) }
gd: یادآوری
اغلب در: <gd:when> استفاده می شود
یک بازه زمانی، که نشان میدهد چه مدت قبل از مشخصه @startTime
یا @dueTime
موجودیت حاوی یک یادآور باید صادر شود. متناوبا، ممکن است زمان مطلقی را مشخص کند که در آن یک یادآوری باید صادر شود. همچنین یک روش اعلان را مشخص می کند که نشان می دهد سیستم باید از چه رسانه ای برای یادآوری کاربر استفاده کند.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@absoluteTime ? | xs:dateTime | زمان مطلقی که در آن تذکر باید صادر شود. این معمولاً زمانی استفاده می شود که کاربر از ویژگی "تعویق" برای به تاخیر انداختن یادآوری قبلی استفاده می کند. اگر منطقه زمانی مشخص نشده باشد، زمان محلی ناظر در نظر گرفته می شود. |
@method ؟ | xs:string | روش اطلاع رسانی که یادآور باید استفاده کند. می تواند هر یک از مقادیر زیر را داشته باشد: alert (باعث نمایش هشدار هنگامی که کاربر در حال مشاهده تقویم در مرورگر است)، email (یک پیام ایمیل برای کاربر می فرستد) یا sms (پیام متنی برای کاربر ارسال می کند). |
@days ؟ | xs:unsignedInt | دوره زمانی قبل از gd:when/@startTime زمانی که باید یادآوری صادر شود. اگر زمان هدف واحد اصلی یک تاریخ باشد نه یک زمان خاص، این ویژگیها نسبت به نیمه شب (00:00) در آن تاریخ است. |
@hours ؟ | xs:unsignedInt | |
@minutes ؟ | xs:unsignedInt |
هنگامی که یک ورودی <gd:when>
ایجاد یا ویرایش می کنید، از قراردادهای زیر برای دستیابی به نتایج خاص استفاده کنید:
- برای اینکه به سرویس بگویید از یادآوری های پیش فرض کاربر استفاده کند، یک عنصر
<gd:reminder>
بدون ویژگی اضافه کنید. اگر مدت زمان را مشخص کنید اما ویژگیmethod
را ندارید، آنگاه این سرویس از روشهای اعلان پیشفرض کاربر با مدت زمانی که شما مشخص کردهاید استفاده میکند. - برای اینکه به سرویس بگویید هیچ یادآوری برای رویداد صادر نکند (یا برای حذف یادآورهای موجود هنگام بهروزرسانی یک رویداد)، هیچ عنصر
<gd:reminder>
را وارد نکنید.
محدودیت های
- حداکثر یکی از
@days
،@hours
،@minutes
، یا@absoluteTime
ممکن است مشخص شود. برای تعیین مدت زمان مختلط، به دقیق ترین واحد تبدیل کنید. به عنوان مثال، برای تعیین 1 ساعت و 30 دقیقه، از@minutes="90"
استفاده کنید. - شما نمی توانید از مقادیر منفی برای ویژگی ها استفاده کنید (بنابراین اگر می خواهید یادآوری بعد از زمان شروع رخ دهد، باید از
@absoluteTime
استفاده کنید). - یک رویداد معین نمیتواند بیش از پنج یادآور مرتبط با خود داشته باشد.
- وقتی یادآوری را به یک رویداد اضافه میکنید، اگر روشهای
alert
،email
یاsms
را مشخص میکنید، باید مدت زمان را نیز مشخص کنید.
مثال ها
یادآوری 15 دقیقه ای برای یک جلسه:
<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"> <gd:reminder minutes="15"/> </gd:when>
همان جلسه فوق، اما به مدت 10 دقیقه پس از یادآوری در ساعت 16:45 به تعویق افتاد:
<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"> <gd:reminder minutes="15"/> <gd:reminder absoluteTime="2005-06-06T16:55:00-08:00"/> </gd:when>
طرحواره
start = reminder reminder = element gd:reminder { gdCommonProperties, attribute absoluteTime { xs:dateTime }?, attribute method { xs:string }?, attribute days { xs:unsignedInt }?, attribute hours { xs:unsignedInt }?, attribute minutes { xs:unsignedInt }? }
gd:resourceId
یک شناسه منبع غیر شفاف، متمایز از atom:id زیرا نیازی به یک URI معتبر نیست. برخی از سرویس ها یک شناسه جداگانه برای استفاده در هنگام ساخت درخواست های بعدی ارائه می دهند. استفاده دقیق مختص سرویس است.
مثال
<gd:resourceId>9749638</gd:resourceId>
طرحواره
start = resourceId resourceId = element gd:resourceId { xs:string }
gd: وقتی
نشان دهنده یک دوره زمانی یا یک لحظه است.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@endTime ? | xs:dateTime یا xs:date | زمان پایان رویداد را توصیف می کند. اگر منطقه زمانی مشخص نشده باشد، منطقه زمانی محلی ناظر در نظر گرفته می شود. |
@startTime | xs:dateTime یا xs:date | زمان شروع رویداد یا (برای رویدادهای با مدت زمان صفر) زمانی که رخ می دهد را توصیف می کند. اگر منطقه زمانی مشخص نشده باشد، منطقه زمانی محلی ناظر در نظر گرفته می شود. |
@valueString ? | xs:string | یک مقدار رشته ساده که می تواند به عنوان نمایشی از این دوره زمانی استفاده شود. |
محدودیت های
- ترکیب
xs:dateTime
باxs:date
درstartTime
/endTime
ممکن نیست. - اگر
endTime
مشخص نشده باشد، رویداد به عنوان یک لحظه در زمان در نظر گرفته می شود (اگر@startTime
شامل یک زمان باشد) یا یک رویداد یک روزه (اگر@startTime
فقط یک تاریخ باشد).
مثال ها
رویداد یک روزه:
<gd:when startTime="2005-06-06"/>
نمایندگی جایگزین یک رویداد یک روزه:
<gd:when startTime="2005-06-06" endTime="2005-06-07"/>
یک رویداد دو روزه (در 6 ژوئن و 7 ژوئن) با شرح رشته:
<gd:when startTime="2005-06-06" endTime="2005-06-08" valueString="This weekend"/>
جلسه یک ساعته:
<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"/>
رویدادی با مدت زمان صفر:
<gd:when startTime="2005-06-06T17:00:00-08:00"/>
طرحواره
start = when when = element gd:when { gdCommonProperties, attribute startTime { (xs:date | xs:dateTime) }, attribute endTime { (xs:date | xs:dateTime) }?, attribute valueString { xs:string }? }
gd: کجا
مکانی (مانند مکان رویداد) مرتبط با موجودیت حاوی. نوع ارتباط با ویژگی rel
تعیین می شود. جزئیات مکان در یک ورودی جاسازی شده یا مرتبط با مخاطب موجود است.
عنصر <gd:where>
کلی تر از عنصر <gd:geoPt>
است. اولی یک مکان را با استفاده از توضیحات متنی و/یا ورودی مخاطب شناسایی می کند، در حالی که دومی یک مکان را با استفاده از یک موقعیت جغرافیایی خاص شناسایی می کند.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@label ? | xs:string | یک برچسب قابل خواندن توسط کاربر را برای متمایز کردن این مکان از مکان های دیگر مشخص می کند. |
@rel ? | xs:string | رابطه بین موجودیت حاوی و مکان موجود را مشخص می کند. مقادیر ممکن (به زیر مراجعه کنید) توسط عناصر دیگر تعریف می شوند. برای مثال، <gd:when> http://schemas.google.com/g/2005#event را تعریف می کند. |
@valueString ? | xs:string | یک مقدار رشته ساده که می تواند به عنوان نمایشی از این مکان استفاده شود. |
gd: entryLink ? | entryLink | ورودی نشان دهنده جزئیات مکان است. این ورودی باید نوع تماس را اجرا کند. |
مقادیر رابطه
ارزش | شرح |
---|---|
http://schemas.google.com/g/2005#event یا مشخص نشده است | مکانی که رویداد محصور در آن رخ می دهد. |
http://schemas.google.com/g/2005#event.alternate | یک مکان ثانویه به عنوان مثال، یک سایت از راه دور با یک ویدیو کنفرانس به سایت اصلی پیوند می دهد. |
http://schemas.google.com/g/2005#event.parking | یک پارکینگ نزدیک. |
مثال ها
مکان رویداد:
<gd:where valueString="Google Cafeteria (Building 40)"/>
مکان رویداد پیچیده تر:
<gd:where rel="http://schemas.google.com/g/2005#event" valueString="Joe's Pub"> <gd:entryLink href="http://local.example.com/10018/JoesPub"> <gd:entry> <id>http://local.example.com/10018/JoesPub</id> <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/> <content>Nice place to listen to jazz music</content> <link href="http://www.joespub.com"/> <gd:postalAddress>500 West 45th Street, New York, NY 10018</gd:postalAddress> <gd:geoPt lat="40.75" lon="-74.0"/> <gd:phoneNumber>(212) 555-1212</gd:phoneNumber> <gd:email address="info@joespub.com"/> </gd:entry> </gd:entryLink> </gd:where>
رویداد با چندین مکان:
<gd:where label="Mountain View Location (main)" valueString="Google Cafeteria (Building 40)"/> <gd:where rel="http://schemas.google.com/g/2005#event.alternate" label="New York Location (videoconference)" valueString="Metropolis"/>
طرحواره
start = where where = element gd:where { gdCommonProperties, attribute rel { xs:string }?, attribute label { xs:string }?, attribute valueString { xs:string }?, (entryLink?) }
gd: چه کسی
شخص مرتبط با موجودیت حاوی. نوع ارتباط با ویژگی rel
تعیین می شود. جزئیات مربوط به شخص در یک ورودی جاسازی شده یا پیوند داده شده با مخاطب موجود است.
عنصر <gd:who>
می توان برای تعیین فرستندگان و گیرندگان ایمیل، سازمان دهندگان رویداد تقویم و غیره استفاده کرد.
خواص
ویژگی | تایپ کنید | شرح |
---|---|---|
@email @؟ | xs:string | آدرس ایمیل. این ویژگی معمولاً زمانی استفاده میشود که <gd:entryLink> مشخص نشده باشد. آدرس باید با RFC 2822 ، بخش 3.4.1 مطابقت داشته باشد. |
@rel ? | xs:string | رابطه بین موجودیت حاوی و شخص حاوی را مشخص می کند. برای مقادیر احتمالی به زیر مراجعه کنید. |
@valueString ? | xs:string | یک مقدار رشته ساده که می تواند به عنوان نمایشی از این شخص استفاده شود. |
gd: attendeeStatus ؟ | gEnumConstruct | وضعیت شرکت کننده در رویداد فهرست قابل توسعه مستند در زیر. |
gd: attendeeType ? | gEnumConstruct | نوع شرکت کننده در رویداد فهرست قابل توسعه مستند در زیر. |
gd: entryLink ? | entryLink | ورودی نشان دهنده جزئیات شخص است. این ورودی باید نوع تماس را اجرا کند. در بسیاری از موارد، این ورودی از فید تماس می آید. |
مقادیر رابطه
مقادیر معتبر برای @rel به نوع ظاهر شدن عنصر <gd:who>
بستگی دارد.
ارزش | نوع | شرح |
---|---|---|
http://schemas.google.com/g/2005#event.attendee | رویداد | A general meeting/event attendee. |
http://schemas.google.com/g/2005#event.organizer | رویداد | Event organizer. An organizer is not necessarily an attendee. |
http://schemas.google.com/g/2005#event.performer | رویداد | Performer. Similar to http://schemas.google.com/g/2005#event.speaker , but with more emphasis on art than speech delivery. |
http://schemas.google.com/g/2005#event.speaker | رویداد | Speaker. |
http://schemas.google.com/g/2005#message.bcc | Message | Message BCC recipient. |
http://schemas.google.com/g/2005#message.cc | Message | Message CC recipient. |
http://schemas.google.com/g/2005#message.from | Message | Message (email or IM) sender. |
http://schemas.google.com/g/2005#message.reply-to | Message | Intended recipient of a reply message. |
http://schemas.google.com/g/2005#message.to | Message | Message primary recipient. |
gd:attendeeType Values
Value | شرح |
---|---|
http://schemas.google.com/g/2005#event.optional | Optional attendee. |
http://schemas.google.com/g/2005#event.required | Required attendee. |
gd:attendeeStatus Values
Value | شرح |
---|---|
http://schemas.google.com/g/2005#event.accepted | Attendee has accepted. |
http://schemas.google.com/g/2005#event.declined | Attendee has declined. |
http://schemas.google.com/g/2005#event.invited | Invitation has been sent, but the person has not accepted. |
http://schemas.google.com/g/2005#event.tentative | Attendee has accepted tentatively. |
Examples
Email recipients:
<gd:who rel="http://schemas.google.com/g/2005#message.from" email="jo@example.com"/> <gd:who rel="http://schemas.google.com/g/2005#message.to" valueString="Elizabeth" email="liz@example.com"/>
Meeting attendee:
<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo"> <gd:attendeeType value="http://schemas.google.com/g/2005#event.required"/> <gd:attendeeStatus value="http://schemas.google.com/g/2005#event.tentative"/> <gd:entryLink href="http://gmail.com/jo/contacts/Jo"> <entry> <id>http://gmail.com/jo/contacts/Jo</id> <category term="user-tag" label="Google"/> <title>Jo March</title> <gd:email address="jo@example.com"/> <gd:phoneNumber label="work">(650) 555-1212</gd:phoneNumber> </entry> </gd:entryLink> </gd:who>
Event organizer:
<gd:who rel="http://schemas.google.com/g/2005#event.organizer" valueString="Receptionist 41"/>
Schema
start = who who = element gd:who { gdCommonProperties, attribute rel { xs:string }?, attribute email { xs:string }?, attribute valueString { xsd:string }?, (entryLink? & element gd:attendeeType { gEnumConstruct }? & element gd:attendeeStatus { gEnumConstruct }?) }