אזהרה: דף זה עוסק בממשקי API הישנים יותר של Google, בממשקי ה-API של נתוני Google, והוא רלוונטי רק לממשקי ה-API שרשומים בספריית ממשקי ה-API של נתוני Google, שרבים מהם הוחלפו בממשקי API חדשים יותר. למידע על API חדש ספציפי, עיינו במסמכי התיעוד של ה-API החדש. למידע על הרשאת בקשות באמצעות ממשק API חדש יותר, יש לעיין בקטע אימות והרשאה של חשבונות Google.
מבוא
במקרים רבים כדאי להשתמש בשירותים שמשתמשים בממשקי ה-API של נתוני Google כדי לספק קבוצה עקבית של מידע על סוג מסוים של פריט.
לדוגמה, שירותים שונים של Google Data API (או "GData") עשויים לספק פרטים ליצירת קשר של אדם או של ארגון; הגיוני שכל השירותים האלה ישתמשו באותה קבוצה של אלמנטים של פרטים ליצירת קשר.
אוסף האלמנטים שמתארים יחד איש קשר נקרא 'איש קשר'. חלק מהאלמנטים בסוג 'יצירת קשר' הם רכיבי Atom או RSS רגילים. אחרים מוגדרים על ידי Google במרחב שמות שנקרא "מרחב שמות של נתוני Google". המוסכמה היא שמרחב השמות של Google Data מתייחס בדרך כלל לקוד XML באמצעות הכינוי gd:
. לדוגמה, הרכיב שמכיל מספר טלפון או פקס הוא <gd:phoneNumber>
. כתובת ה-URL של הסכימה של מרחב השמות של נתוני Google היא http://schemas.google.com/g/2005.
Google מגדירה גם סוגים אחרים: אירוע (אוסף של אלמנטים סטנדרטיים שמייצגים יחד אירוע ביומן) ו'הודעה' (אוסף של אלמנטים שמייצגים הודעת אימייל, פרסום קבוצת דיונים או הודעה אחרת).
יש כמה סוגים של שמות ממרחב השמות של נתוני Google. לדוגמה, הרכיב <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>
אינו בשימוש בסוג איש הקשר, על אף ש<atom:author>
הוא רכיב חובה ברשומה (אלא אם הוא מצוין בפיד האב), אין לו משמעות שימושית בסוג איש הקשר.
יצירת סוגים
לפעמים קשה להבין בדיוק איזה מידע צריך לכלול בעת יצירת רשומה מסוג מסוים, במיוחד מפני שחלק מהרכיבים מהסוגים מכילים סוגים אחרים.
אחת הגישות שעשויות לעזור היא להשתמש בספריות הלקוח שאנחנו מספקים, במקום לנסות לבנות את הסוגים באופן ידני. ספריות הלקוח מספקות שיטות שונות להוספה ולשינוי של נתונים ברשומה מסוג מסוים. לפרטים נוספים, עיינו במסמכי התיעוד של ספריית הלקוח.
יכולת הרחבה
המידע במסמך הזה לא עוסק בכל המאפיינים האפשריים וערכי המאפיינים האפשריים. השירותים יכולים לכלול סוגים, ולכן ייתכן ששירות מסוים ישתמש במאפיינים ובערכים שאינם כלולים במסמך הזה.
מוסכמות טיפוגרפיות
בטבלאות במסמך אנחנו משתמשים במוסכמות הבאות לרכיבים נדרשים ואופציונליים:
שם רכיב | רכיב נדרש |
Element? | רכיב אופציונלי |
NameName* | רכיב אופציונלי, מספר מופעים מותרים |
רכיבים ומאפיינים מוצגים בסימון XPath סטנדרטי.
סוג יצירת קשר
מייצג איש קשר: אדם, מקום כגון מועדון או מסעדה, או ארגון.
רכיב של קטגוריה: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>
הערה: אם אתם משתמשים בסוג 'אנשי קשר' בהקשר של ממשק ה-API של אנשי קשר, זכרו שסוג איש הקשר 2.0 (המתואר במסמך הזה) משמש את ממשק ה-API של אנשי הקשר, החל מגרסה 3.0 של ממשק ה-API.
נכסים
מאפיין (property) | תיאור |
---|---|
atom:category * |
קטגוריות. מופעים עם המאפיין @label נחשבים לתגים. לקבלת מידע על השימוש במאפיין @scheme , יש לעיין בהערה בתחילת קטע זה. |
atom:content |
הערות לגבי איש הקשר. |
atom:link * |
קישורים למידע קשור. באופן ספציפי, atom:link[@rel='alternate'] מקשר לדף HTML שמתאר את איש הקשר. |
atom:title |
שם איש הקשר. זהו שדה לקריאה בלבד. כדי לשנות את שם איש הקשר, ראה gd:name . |
gd:email * |
כתובות אימייל. |
gd:extendedProperty * |
נכס מורחב. |
gd:deleted ? |
אם הרכיב הזה מופיע, הרשומה של איש הקשר נמחקה. |
gd:im * |
כתובות IM. |
gd:name ? |
שם איש הקשר בפורמט מובנה. |
gd:organization * |
ארגון. |
gd:phoneNumber * |
מספרי טלפון ופקס. |
gd:structuredPostalAddress * |
הכתובת של איש הקשר בפורמט מובנה. |
gd:where ? |
מקום המשויך לאיש הקשר. |
דוגמאות
<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>
סוג הפרופיל
מייצג פרופיל המשויך למשתמש Google או לישות אחרת. לסוג הפרופיל יש מבנה דומה לסוג איש הקשר. עם זאת, היא שונה בדרכים מסוימות: היא לא יכולה להכיל נכסים מורחבים או להיות מסומנת כמחיקה, לדוגמה.
רכיב של קטגוריה: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#profile"/>
סוג הפרופיל הושק בגרסה 3.0 של ממשק ה-API של אנשי קשר.
נכסים
מאפיין (property) | תיאור |
---|---|
atom:category * |
קטגוריות. מופעים עם המאפיין @label נחשבים לתגים. למידע נוסף על השימוש במאפיין @scheme , יש לקרוא את ההערה "רכיב קטגוריה" בתחילת קטע זה. |
atom:content |
הערות בנוגע לפרופיל. |
atom:link * |
קישורים למידע קשור. באופן ספציפי, הקישור של atom:link[@rel='alternate'] לדף HTML מתאר את הפרופיל. |
atom:title |
שם הפרופיל. זהו שדה לקריאה בלבד. |
gd:email * |
כתובות אימייל. |
gd:im * |
כתובות IM. |
gd:name ? |
שם, בפורמט מובנה. |
gd:organization * |
ארגון. |
gd:phoneNumber * |
מספרי טלפון ופקס. |
gd:structuredPostalAddress * |
כתובת למשלוח דואר, בפורמט מובנה. |
gd:where ? |
מקום המשויך לפרופיל. |
דוגמאות
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:batch='http://schemas.google.com/gdata/batch' xmlns:gd='http://schemas.google.com/g/2005' <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#profile' /> <title>Elizabeth Bennett</title> <gd:name> <gd:givenName>Elizabeth</gd:givenName> <gd:familyName>Bennett</gd:familyName> </gd:name> <gd:structuredPostalAddress rel='http://schemas.google.com/g/2005#work'> <gd:formattedAddress>Longbourne, Nr. Meryton, Hertfordshire, England</gd:formattedAddress> </gd:structuredPostalAddress> </entry>
סוג האירוע
מייצג אירוע ביומן. המיקום של האירוע מיוצג על ידי סוג של איש קשר שמוטמע ברכיב <gd:where>
(או מקושר ממנו), והמארגנים והמשתתפים מיוצגים כסוגים של אנשי קשר שמוטמעים ברכיבי <gd:who>
(או מקושרים מהם).
רכיב של קטגוריה: <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/>
נכסים
מאפיין (property) | תיאור |
---|---|
atom:author |
האדם שיצר את האירוע. |
atom:category * |
קטגוריות. מופעים עם המאפיין @label נחשבים לתגים. לקבלת מידע על השימוש במאפיין @scheme , יש לעיין בהערה בתחילת קטע זה. |
atom:content |
תיאור ארוך יותר של האירוע. |
atom:link * |
קישורים. באופן ספציפי, atom:link[@rel='alternate'] מספק קישור לדף HTML שמתאר את האירוע. |
atom:title |
השם הקצר של האירוע. |
gd:comments ? |
פיד תגובות. |
gd:eventStatus ? |
אלו הם פריטים שניתנים להרחבה. |
gd:extendedProperty * |
נכס מורחב. |
gd:originalEvent ? |
מזהה האירוע המקורי של אירועים חוזרים. |
gd:recurrence ? |
כלל חזרה. |
gd:transparency ? |
מספרי enum הניתנים להרחבה מפורטים בהמשך, בהתאם לנכס 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 for gd:where
ערך rel | תיאור |
---|---|
http://schemas.google.com/g/2005#event לא צוין. |
המקום שבו מתקיים האירוע. |
http://schemas.google.com/g/2005#event.alternate |
מיקום משני. לדוגמה, אתר מרוחק עם קישור לשיחת ועידה לאתר הראשי. |
http://schemas.google.com/g/2005#event.parking |
מגרש חניה בקרבת מקום. |
ערכי gd:eventStatus
ערך | תיאור |
---|---|
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"/>
נכסים
מאפיין (property) | תיאור |
---|---|
atom:category * |
קטגוריות. מופעים עם המאפיין @label נחשבים לתגים. לקבלת מידע על השימוש במאפיין @scheme , יש לעיין בהערה בתחילת קטע זה. בטבלה שבהמשך מופיע מידע על השימוש במאפיין @term . |
atom:content |
גוף ההודעה. |
atom:link * |
קבצים מצורפים של הודעות. באופן ספציפי, כדי להעלות קובץ מצורף, צריך להשתמש בכלי <link rel="enclosure"> ולמקם את התוכן שלו בקובץ המדיה. |
atom:title |
נושא ההודעה. |
gd:geoPt ? |
המיקום הגיאוגרפי שממנו פורסמה ההודעה. |
gd:rating ? |
דירוג איכות (כפי שהוגדר על ידי האפליקציה). |
gd:who * |
האנשים שמשויכים להודעה זו. הסמנטיקה המדויקת תלויה בערך @rel . יש לעיין בטבלה הבאה. |
ערכי @term של קטגוריות
כל הקטגוריות הבאות מופיעות בסכימה 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 for gd:who
מאפיין (property) | תיאור |
---|---|
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:additionalName
- gd:comments
- gd:country
- gd:deleted
- gd:email
- gd:entryLink
- gd:extensionProperty
- gd:familyName
- gd:feedLink
- gd:geoPt
- gd:givenName
- gd:im
- gd:Organization
- gd:orgDepartment
- gd:orgJobDescription
- gd:orgName
- gd:orgSymbol
- gd:orgTitle
- gd:originalEvent
- gd:phoneNumber
- gd:postalAddress
- gd:rating
- gd:חזרה
- gd:חזרה על חריגה
- gd:reminder
- gd:structuredPostalAddress
- gd:מתי
- gd:where
- gd:who
Enums
ברכיבי תוספים מסוימים יש לציין מאפיינים שהערכים שלהם מגיעים מקבוצת מספרים. המצב הכללי של נכסים כאלה הוא:
<gd:propertyName value="propertyValue">
אם ערך הנכס מגיע ממרחב השמות של נתוני Google, הוא מקבל את הטופס http://schemas.google.com/g/2005#
{kind}.
{value}. לדוגמה: 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 באמצעות מאפיינים משותפים בכל מרחב שמות. באופן ספציפי, אסור לרכיב כל רכיב gd או רכיב Atom/RSS כלשהם בתוך רכיב gd אחר. צריך לפעול בצורה הזהירה, וברוב המקרים צריך לתעד את השימוש הזה כנכס בוטה מסוג רכיב ה-gd שמכיל את הרכיב.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@xml:base |
uri |
מבנה XML סטנדרטי לתיאור הבסיס של URI יחסי. |
@xml:lang |
text |
השפה של מחרוזות מקוננות. |
סכימה
namespace gd = "http://schemas.google.com/g/2005" gdCommonProperties = { atomCommonAttributes, anyAttribute*, (anyElement*) }
gd:additionalName
מציין שם נוסף (למשל, אמצעי) של האדם, למשל "צריך".
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@yomi ? |
xs:string |
ייצוג כספי. |
text() |
xs:string |
שם המשפחה של האדם. |
דוגמה
<gd:additionalName yomi="'suz@n">Susan<gd:additionalName>
סכימה
start = additionalName additionalName = element gd:additionalName { attribute yomi { xs:string }?, (xs:string) }
gd:תגובות
מכיל עדכון תגובות עבור הערך המקיף (כגון אירוע ביומן).
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@rel ? |
xs:string |
סוג התגובות הכלולות. בשלב זה, יש הבחנה בין תגובות רגילות לביקורות. |
gd:feedLink ? |
feedLink |
פיד תגובות. הפיד הזה צריך להטמיע את הסוג הודעה. |
ערכי rel
ערך | תיאור |
---|---|
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:country
שם מדינה וקוד מדינה אופציונלי. השם השני מתקבל בהתאם ל-ISO 3166-1 alpha-2.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@code ? |
xs:string |
קוד מדינה, למשל בתקן ISO 3166-1 alpha-2. |
text() |
xs:string |
שם המדינה. |
דוגמאות
<gd:country code='PL'>Poland</gd:country> <gd:country>Gabon</gd:country>
סכימה
start = country country = element gd:country { attribute code { xs:string }?, xs:string? }
gd:אימייל
כתובת אימייל שמשויכת לישות המכילה (בדרך כלל היא ישות שמייצגת אדם או מיקום).
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@address |
xs:string |
כתובת אימייל. |
@displayName ? |
xs:string |
השם המוצג של הישות (למשל, אדם) שכתובת האימייל שייכת לו. |
@label ? |
xs:string |
ערך מחרוזת פשוט המשמש למתן שם לכתובת האימייל הזו. היא מאפשרת בממשקי משתמש להציג תווית כגון 'עבודה', 'אישי', 'מועדף' וכו'. |
@rel ? |
xs:string |
ערך פרוגרמטי שמזהה את סוג האימייל. פרטים נוספים מופיעים בהמשך. |
@primary ? |
xs:boolean |
כאשר מספר תוספי אימייל מופיעים בסוג איש קשר, הוא מציין איזה מהם הוא הראשי. הודעת אימייל אחת יכולה להיות כתובת האימייל הראשית. ערך ברירת המחדל הוא "false" . |
ערכי rel
ערך | תיאור |
---|---|
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" displayName="Foo Bar" /> <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 displayName { xs:string }?, attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }? }
gd:entryLink
ייצוג מקובל מבחינה לוגית. לדוגמה, הפונקציה <gd:who>
שמייצגת איש קשר עשויה לכלול רשומה מקוננת מפיד של איש קשר.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@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:extensionProperty
מאפשרת לאחסן כמות מוגבלת של נתונים מותאמים אישית כנכס עזר של הישות שמופיעה.
לידיעתך, נוכחות anyForeignElement
מאפשרת להטמעה להטמיע
XML חוקי כלשהו בתוך רכיב gd:extendedProperty
(באופן בלעדי, עם מאפיין value
).
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@name |
xs:string |
מציין את שם המאפיין המתואר כ-URI. כתובות URI של נכסים מורחבים בדרך כלל תואמות למוסכמה {schema}#{local-name}. |
@value ? |
xs:string |
ערך הנכס. |
@realm ? |
xs:string |
בחלק מממשקי ה-API נעשה שימוש כדי לציין איפה חל הנכס המורחב. |
דוגמה
מזהה חיצוני של אירוע ביומן:
<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*), attribute realm { xs:string } ? }
gd:familyName
קביעת שם המשפחה של האדם, למשל "סמית".
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@yomi ? |
xs:string |
ייצוג פונטי. |
text() |
xs:string |
שם המשפחה של האדם. |
דוגמה
<gd:familyName yomi="smɪð">Smith<gd:familyName>
סכימה
start = familyName familyName = element gd:familyName { attribute yomi { xs:string }?, (xs:string) }
gd:feedLink
מייצג פיד עם רכיב לוגי. לדוגמה, פיד של יומן עשוי לכלול פיד מקנן שמייצג את כל התגובות בכניסות.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@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
מיקום גיאוגרפי (קו רוחב, קו אורך, גובה).
הוצאה משימוש. הרכיב הזה הוצא משימוש. לנתוני תיוג גיאוגרפי, יש להשתמש במקום זאת במיקום גיאוגרפי.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@elev ? |
xs:float |
גובה במטרים. ערכים שליליים מציינים עומקים מתחת לפני הים. |
@label ? |
xs:string |
ערך מחרוזת פשוט המשמש לקביעת המיקום הזה. היא מאפשרת לממשקי משתמש להציג תווית כגון 'מיקום נוכחי'. |
@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
כתובת מיידית להעברת הודעות המשויכת לישות המכילה.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@address |
xs:string |
כתובת מיידית. |
@label ? |
xs:string |
ערך מחרוזת פשוט שמשמש כדי לתת שם לכתובת ה-IM. היא מאפשרת בממשקי משתמש להציג תווית כגון 'עבודה', 'אישי', 'מועדף' וכו'. |
@rel ? |
xs:string |
ערך פרוגרמטי שמזהה את סוג ההודעות המיידיות. לפרטים נוספים, ראה בהמשך. |
@protocol ? |
xs:string |
מזהה את רשת ההודעות המיידיות. הערך יכול להיות אחד מהערכים הרגילים (מוצג בהמשך), או URI שמזהה רשת IM קניינית. |
@primary ? |
xs:boolean |
כאשר מספר תוספים של הודעות מיידיות מופיעים בסוג איש קשר, מציין איזה מהם הוא הראשי. הודעה מיידית אחת יכולה להיות לכל היותר. ערך ברירת המחדל הוא "false" . |
ערכי rel
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#home |
|
http://schemas.google.com/g/2005#netmeeting |
|
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 |
http://schemas.google.com/g/2005#MSN |
פרוטוקול MSN Messenger |
http://schemas.google.com/g/2005#YAHOO |
פרוטוקול Yahoo Messenger |
http://schemas.google.com/g/2005#SKYPE |
פרוטוקול 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 |
פרוטוקול 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:givenName
מציינת את השם הפרטי של האדם, למשל "דני".
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@yomi ? |
xs:string |
ייצוג פונטי. |
text() |
xs:string |
השם הפרטי של האדם. |
דוגמה
<gd:givenName yomi="dʒon">John<gd:givenName>
סכימה
start = givenName givenName = element gd:givenName { attribute yomi { xs:string }?, (xs:string) }
gd:money
מציינת את סכום הכסף במטבע מסוים.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@amount |
xsd:float |
סכום הכסף. |
@currencyCode |
xsd:string |
קוד המטבע ISO4217. |
דוגמה
<gd:money amount='650.0' currencyCode='EUR'/>
סכימה
element gd:money { attribute amount { xsd:float }, attribute currencyCode { xsd:string } }
gd:name
אפשר לאחסן את שם האדם באופן מובנה. מורכב משם נתון, שם נוסף, שם משפחה, קידומת, סיומת ושם מלא.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
gd:givenName ? |
givenName |
השם הפרטי של האדם. |
gd:additionalName ? |
additionalName |
שם נוסף של האדם, למשל שם אמצעי. |
gd:familyName ? |
familyName |
שם המשפחה של האדם. |
gd:namePrefix ? |
namePrefix |
תחילית כבוד, למשל 'מר' או 'גברת'. |
gd:nameSuffix ? |
nameSuffix |
סיומת של תואר כבוד, למשל 'san' או 'III'. |
gd:fullName ? |
fullName |
ייצוג לא מובנה של השם. |
דוגמה
ייצוג מובנה של סר וינסטון לאונרד ספנסר-צ'רצ'יל, קנזס
<gd:name> <gd:givenName>Winston</gd:givenName> <gd:additionalName>Leonard</gd:additionalName> <gd:familyName>Spencer-Churchill</gd:familyName> <gd:namePrefix>Sir</gd:namePrefix> <gd:nameSuffix>OG</gd:nameSuffix> </gd:name>
סכימה
start = name name = element gd:name { givenName? & additionalName? & familyName? & namePrefix? & nameSuffix? }
ההגבלות
- רכיב לא מובנה של השם צריך להיות תואם לייצוג המובנה שלו.
gd:ארגון
ארגון שמשויך בדרך כלל לאיש קשר.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@label ? |
xs:string |
ערך מחרוזת פשוט המשמש למתן שם לארגון זה. היא מאפשרת לממשקי משתמש להציג תווית כגון "עבודה", "התנדבות", "חברה מקצועית" וכו'. |
gd:orgDepartment ? |
orgDepartment |
מציין מחלקה בתוך הארגון. |
gd:orgJobDescription ? |
orgJobDescription |
תיאור המשרה בארגון. |
gd:orgName ? |
orgName |
שם הארגון. |
gd:orgSymbol ? |
orgSymbol |
הסמל של הארגון. |
gd:orgTitle ? |
orgTitle |
התפקיד של אדם מסוים בארגון. |
@primary ? |
xs:boolean |
כאשר מספר תוספים של ארגונים מופיעים בסוג איש קשר, הוא מציין איזה מהם הוא הראשי. ארגון אחד לכל היותר יכול להיות ראשי. ערך ברירת המחדל הוא "false" . |
@rel ? |
xs:string |
ערך פרוגרמטי שמזהה את סוג הארגון. פרטים נוספים מופיעים בהמשך. |
gd:where ? |
where |
מקום המשויך לארגון, למשל מיקום המשרד. |
ערכי rel
ערך | תיאור |
---|---|
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:orgJobDescription>Writes documentation</gd:orgJobDescription> <gd:orgDepartment>Software Development</gd:orgDepartment> <gd:orgSymbol>GOOG</gd:orgSymbol> </gd:organization>
סכימה
start = organization organization = element gd:organization { attribute label { xs:string }?, attribute rel { xs:string }?, attribute primary { xs:boolean }?, ( orgDepartment? & orgJobDescription? & orgName? & orgSymbol? & orgTitle? & where? ) }
gd:orgמחלקה
מתאר מחלקה בתוך ארגון. חייב להופיע בתוך רכיב gd:organization
.
דוגמה
<gd:orgDepartment>Research and Development</gd:orgDepartment>
סכימה
start = orgDepartment orgDepartment = element gd:orgDepartment { xs:string }
gd:orgJobDescription
מתאר משימה בתוך ארגון. חייב להופיע בתוך רכיב gd:organization
.
דוגמה
<gd:orgJobDescription>Documenting public APIs</gd:orgJobDescription>
סכימה
start = orgJobDescription orgJobDescription = element gd:orgJobDescription { xs:string }
gd:orgName
שם הארגון. חייב להופיע בתוך רכיב gd:organization
.
נכסים
מאפיין (property) | תיאור |
---|---|
@yomi ? |
יומיגאנה (התקן קריאה יפני) עבור שם הארגון. |
דוגמה
<gd:orgName>Google, Inc.</gd:orgName>
סכימה
start = orgName orgName = element gd:orgName { attribute yomi {xs:string}, xs:string }
gd:orgSymbol
סמל של ארגון. חייב להופיע בתוך רכיב gd:organization
.
דוגמה
<gd:orgSymbol>GOOG</gd:orgSymbol>
סכימה
start = orgSymbol orgSymbol = element gd:orgSymbol { xs:string }
gd:orgTitle
התפקיד של אדם מסוים בארגון. חייב להופיע בתוך רכיב gd:organization
.
דוגמה
<gd:orgTitle>President and CEO</gd:orgTitle>
סכימה
start = orgTitle orgTitle = element gd:orgTitle { xs:string }
gd:originalEvent
זהה לנכס מזהה החזרה שצוין בסעיף 4.8.4.4 ב-RFC 2445. הוא מופיע בכל מופע של אירוע חוזר, כדי לזהות את האירוע המקורי.
כולל רכיב <gd:when>
שמציין את שעת ההתחלה המקורית של המופע, שהפך לחריג.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@id |
xs:string |
מזהה האירוע של האירוע המקורי. |
@href |
xs:string |
כתובת ה-URL של פיד האירועים של האירוע המקורי. |
דוגמה
ציון אירוע מקורי:
<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:phoneNumber
מספר טלפון המשויך לישות המכילה (בדרך כלל היא ישות שמייצגת אדם או מיקום).
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@label ? |
xs:string |
ערך מחרוזת פשוט המשמש למתן שם למספר הטלפון הזה. ברוב המקרים, אין צורך ב-@label כי @rel מזהה באופן ייחודי מספר ומאפשר לממשקי משתמש להציג תווית מתאימה כמו 'נייד', 'בית', 'עבודה' וכו'. עם זאת, במקרים שבהם לאדם אחד (לדוגמה) יש כמה טלפונים ניידים, אפשר להשתמש במאפיין הזה כדי להבדיל ביניהם. |
@rel ? |
xs:string |
ערך פרוגרמטי המזהה את סוג מספר הטלפון. פרטים נוספים מופיעים בהמשך. |
@uri ? |
xs:string |
"URI URI" אופציונלי המשמש לייצוג המספר באופן רשמי, שימושי לגישה פרוגרמטית, כגון גשר VoIP/PSTN. אפשר לקבל מידע נוסף על מזהי URI של RFC 3966. |
@primary ? |
xs:boolean |
כאשר מספר תוספים של מספרי טלפון מופיעים בסוג של איש קשר, סימן זה הוא הראשי. מספר טלפון אחד לכל היותר יכול להיות ראשי. ערך ברירת המחדל הוא "false" . |
text() |
xs:string |
מספר טלפון קריא למשתמשים. אפשר להשתמש בכל מספר טלפון. רווח בהתחלה ובסוף אינו משמעותי. גם שורות השורה במחרוזת אינן משמעותיות, וניתן להסיר או לרווח אותן בחלל יחיד. |
ערכי rel
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#assistant |
|
http://schemas.google.com/g/2005#callback |
|
http://schemas.google.com/g/2005#car |
|
http://schemas.google.com/g/2005#company_main |
|
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#isdn |
|
http://schemas.google.com/g/2005#main |
|
http://schemas.google.com/g/2005#mobile |
|
http://schemas.google.com/g/2005#other |
סוג מיוחד של מספר שאין לו ערך אחר של rel . אפשר להשתמש במאפיין label כדי לציין את הסוג בפועל. |
http://schemas.google.com/g/2005#other_fax |
|
http://schemas.google.com/g/2005#pager |
|
http://schemas.google.com/g/2005#radio |
|
http://schemas.google.com/g/2005#telex |
|
http://schemas.google.com/g/2005#tty_tdd |
|
http://schemas.google.com/g/2005#work |
|
http://schemas.google.com/g/2005#work_fax |
|
http://schemas.google.com/g/2005#work_mobile |
|
http://schemas.google.com/g/2005#work_pager |
דוגמאות
מספר טלפון פשוט שהמשתמש הזין:
<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
כתובת למשלוח דואר.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@label ? |
xs:string |
ערך מחרוזת פשוט המשמש למתן שם לכתובת זו. |
@rel ? |
xs:string |
ערך פרוגרמטי שמזהה את סוג כתובת הדואר. לפרטים נוספים, אפשר לעיין למטה. |
@primary ? |
xs:boolean |
כאשר מספר סיומות של כתובות דואר מופיעות בסוג של איש קשר, סימן שהוא הראשי. הכתובת יכולה להיות כתובת ראשית אחת לכל היותר. ערך ברירת המחדל הוא "false" . |
text() |
xs:string |
הכתובת כטקסט. רווח בהתחלה ובסוף אינו משמעותי. שורות חדשות בתוך המחרוזת הן בעלות משמעות. |
ערכי rel
ערך | תיאור |
---|---|
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.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@average ? |
xs:float |
דירוג ממוצע. |
@max |
xs:int |
הערך המקסימלי של סולם הדירוג. |
@min |
xs:int |
הערך המינימלי של סולם הדירוג. |
@numRaters ? |
xs:int |
מספר הדירוגים שנלקחו בחשבון במהלך חישוב הערך הממוצע. |
@rel ? |
xs:string |
מציין את ההיבט שמסווג. אם לא צוין, דירוג הוא דירוג כולל. |
@value ? |
xs:int |
ערך דירוג. |
ערכי rel
ערך | תיאור |
---|---|
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.) השלב האחרון כולל רכיב VMONTH, המספק כללים מפורטים של אזור זמן לכל מזהה של אזור זמן המוזכר במאפיינים הקודמים.
שירותי Google, כמו יומן Google, בדרך כלל לא מייצרים נכסי EXRULE ו-EXDATE כדי לייצג חריגים לאירועים חוזרים. במקום זאת, הם יוצרים אלמנטים של <gd:recurrenceException>
. עם זאת, שירותי Google עשויים לכלול נכסי EXRULE ו/או EXDATE בכל מקרה. לדוגמה, משתמשים יכולים לייבא אירועים וחריגים ליומן, ואם האירועים המיובאים מכילים נכסי EXRULE או EXDATE, היומן יספק את הנכסים האלה כשהוא ישלח רכיב <gd:recurrence>
.
שימו לב שהשימוש ב-<gd:recurrenceException>
מאפשר לכם להיות בטוחים שלא רק בודקים רכיב <gd:recurrence>
אם יש חריגים לתיאור החזרה. כדי להבטיח שתמצאו את כל החריגים, יש לחפש רכיבי <gd:recurrenceException>
בפיד ולהשתמש ברכיבים מסוג <gd:originalEvent>
כדי להתאים להם רכיבים מסוג <gd:recurrence>
.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
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:אירוע חריג
ייצוג של אירוע חריג לאירוע חוזר - כלומר, מופע של אירוע חוזר שבו היבט אחד או יותר של האירוע החוזר (כמו רשימת נוכחות, שעה או מיקום) השתנה.
מכיל רכיב <gd:originalEvent>
שמציין את האירוע החוזר המקורי שהאירוע הזה חריג בו.
כשמשנים מופע של אירוע חוזר, המופע הזה יוצא מן הכלל. בהתאם לשינוי שערכתם, החריגה מתנהגת בשתי דרכים שונות כשהאירוע החוזר המקורי משתנה:
- אם מוסיפים, משנים או מסירים תגובות, משתתפים או תגובות של משתתפים, החריגה נשארת קשורה לאירוע המקורי והשינויים באירוע המקורי משנים גם את החריגה.
- אם תערכו שינויים חריגים אחרים (כמו שינוי השעה או המיקום), המופע יהפוך ל"מתמחה", כלומר הוא לא יהיה קשור יותר לאירוע המקורי. אם משנים את האירוע המקורי, החריגים המיוחדים לא משתנים. אבל בהמשך אפשר לקרוא על כך.
לדוגמה, נניח שיש לכם פגישה בכל יום שלישי וחמישי בשעה 14:00. אם תשנו את רשימת הנוכחות של הפגישה ביום חמישי (אבל לא את הפגישה שנקבעה באופן קבוע), היא תהיה חריגה. אם משנים את מועד הפגישה ביום חמישי (אבל לא את הפגישה שנקבעה באופן קבוע), היא תהפוך למומחית.
בין אם החריגה היא מיוחדת ובין אם לא, אם מבצעים פעולה שמוחקת את המופע שבו החריג נגזר, החריגה נמחקת. הערה: שינוי היום או השעה של אירוע חוזר גורם למחיקת כל המופעים וליצירת אירועים חדשים.
לדוגמה, נניח שאתם מתמחים בפגישה ביום חמישי כדי לשנות את הפגישה החוזרת ליום שני, רביעי ושישי. השינוי הזה ימחק את כל המופעים החוזרים של הפגישה ביום שלישי/חמישי, כולל האירוע המיוחד.
אם מופע מסוים של אירוע חוזר נמחק, המופע הזה מופיע כ-<gd:recurrenceException>
עם <gd:entryLink>
שה-<gd:eventStatus>
שלו מוגדר ל-"http://schemas.google.com/g/2005#event.canceled"
. (למידע נוסף על אירועים שבוטלו, עיינו ב-RFC 2445.)
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@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:reminder
השימוש הנפוץ ביותר ב: <gd:when>
מרווח זמן, שמציין כמה זמן לפני הפקת התזכורת יש לציין ישות @startTime
או @dueTime
של הישות המכילה. לחלופין, ניתן לציין את הזמן המוחלט שבו יש לשלוח תזכורת. מציין גם שיטת התראה, המציינת באיזה אמצעי תשלום המערכת צריכה להשתמש כדי להזכיר למשתמש.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@absoluteTime ? |
xs:dateTime |
הזמן המוחלט שבו יש לשלוח את התזכורת. בדרך כלל משתמשים באפשרות הזו אם משתמשים בתכונה "נודניק" כדי לדחות תזכורת קודמת. אם לא מציינים את אזור הזמן, המערכת משתמשת בשעון המקומי של הצופה. |
@method ? |
xs:string |
שיטת ההתראה שבה ייעשה שימוש בתזכורת. הערכים הבאים יכולים להיות: alert (גורם התראה להופיע כשהמשתמש צופה ביומן בדפדפן), email (שולח למשתמש הודעת אימייל) או sms (נשלח למשתמש הודעת טקסט ב-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
. כדי לציין משך זמן מעורב, צריך להמיר ליחידה המדויקת ביותר. לדוגמה, כדי לציין שעה אחת ו-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:structuredPostalAddress
כתובת הדואר מפוצלת לרכיבים. היא מאפשרת לאחסן את הכתובת בפורמט עצמאי תלוי מיקום. ניתן לפרש את השדות ולהשתמש בהם כדי ליצור כתובת בפורמט תלוי-פורמט. הרכיבים הבאים מאפיינים חלקים של הכתובת: סוכן, שם בית, רחוב, תיבת דואר, שכונה, עיר, אזור משנה, אזור, מיקוד, מדינה. הרכיב אזור משנה לא משמש לכתובות אימייל. הוא מיועד לשימושים ארוכים בלבד של כתובות. כדי לאחסן כתובת למשלוח דואר בפורמט שדה מפורמט בפורמט לא מובנה.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@rel ? |
xs:string |
סוג הכתובת. אלא אם ההנחה היא הסוג של work . |
@mailClass ? |
xs:string |
סיווגי דואר קבילים בכתובת. אלא אם צוין ההנחה של both . |
@usage ? |
xs:string |
ההקשר שבו אפשר להשתמש בהוספה הזו. כתובות מקומיות עשויות להיות שונות בפריסה מכתובות כלליות, ובדרך כלל משתמשים גם בסקריפט מקומי (בניגוד לכתב לטיני). עם זאת, סקריפטים מקומיים מותרים בכתובות כלליות. אלא אם צוין שימוש ב-general . |
@label ? |
xs:string |
תווית כללית לכתובת. |
@primary ? |
xs:boolean |
מציינת את הכתובת כראשית. ערך ברירת המחדל הוא false . |
gd:agent ? |
agent |
הנציג בפועל שמקבל את האימייל. בשימוש בכתובות עבודה. גם עבור 'בטיפול' או 'c/o'. |
gd:housename ? |
housename |
משמש במקומות שבהם לבתים או לבניינים יש שמות (ולא בהכרח מספרים), למשל. 'העמודים'. |
gd:street ? |
street |
יכול להיות רחוב, שדרה, כביש וכו'. רכיב זה כולל גם את מספר הבית ומספר החדר/דירה/קומה. |
gd:pobox ? |
pobox |
כיסויים לתיבות דואר בפועל, מגירות, תיקים נעולים וכו'. בדרך כלל, פריטים כאלה לא תמיד מתואמים ברחוב. |
gd:neighborhood ? |
neighborhood |
תווית זו מאפשרת להבהיר כתובת רחוב כאשר עיר מכילה יותר מרחוב אחד בעל שם זהה, או כדי לציין מקום קטן שהדואר שלו מנותב דרך עיר דואר גדולה יותר. סין יכולה להיות מחוז או עיר קטנה. |
gd:city ? |
city |
יכול להיות עיר, כפר, עיירה, רובע וכו'. זו עיר הדואר ולא בהכרח מקום המגורים או העסק. |
gd:subregion ? |
subregion |
ניהול מחוזות מנהליים, כגון מחוזות בארה"ב או בבריטניה, שאינם משמשים למטרות כתובת בדואר. אזור המשנה אינו מיועד לכתובות למשלוח. |
gd:region ? |
region |
מדינה, מחוז (באירלנד), מדינה (בגרמניה), יציאה (בצרפת) וכו'. |
gd:postcode ? |
postcode |
מיקוד. בדרך כלל כלל-ארצי, אך לפעמים ספציפי לעיר (לדוגמה, "2" בכתובות "דבלין 2, אירלנד"). |
gd:country ? |
country |
השם או הקוד של המדינה. |
gd:formattedAddress ? |
formattedAddress |
כתובת הדואר המלאה שאינה מובנית. |
ערכי rel
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#work |
כתובת העבודה. אם לא צוין אחרת, זהו ערך ברירת המחדל. |
http://schemas.google.com/g/2005#home |
כתובת המגורים. |
http://schemas.google.com/g/2005#other |
כל סוג אחר של כתובת. |
ערכי mailClass
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#both |
ניתן לשלוח חבילות ומכתבים לכתובת. אם לא צוין אחרת, זהו ערך ברירת המחדל. |
http://schemas.google.com/g/2005#letters |
ניתן לשלוח לכתובת רק אותיות. |
http://schemas.google.com/g/2005#parcels |
ניתן לשלוח לכתובת רק חבילות. |
http://schemas.google.com/g/2005#neither |
הכתובת מבוססת על מיקום בלבד ולא ניתן להשתמש בה לשליחת דואר. |
ערכי שימוש
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#general |
הכתובת מיועדת לשימוש כללי. אם לא צוין אחרת, זהו ערך ברירת המחדל. |
http://schemas.google.com/g/2005#local |
הכתובת הזו מיועדת לשימוש מקומי. |
דוגמאות
כתובת החברה:
<gd:structuredPostalAddress mailClass='http://schemas.google.com/g/2005#letters' label='John at Google'> <gd:street>1600 Amphitheatre Parkway</gd:street> <gd:city>Mountain View</gd:city> <gd:region>CA</gd:region> <gd:postcode>94043</gd:postcode> </gd:structuredPostalAddress>
כתובת פרטית:
<gd:structuredPostalAddress mailClass='http://schemas.google.com/g/2005#both' label='Madame Duval'> <gd:street>27, rue Pasteur</gd:street> <gd:city>CABOURG</gd:city> <gd:postcode>14390</gd:postcode> <gd:country>FRANCE</gd:country> </gd:structuredPostalAddress>
סכימה
start = structuredPostalAddress structuredPostalAddress = element gd:structuredPostalAddress { attribute label { xs:string }?, attribute mailClass { xs:string }?, attribute primary { xs:boolean }?, attribute rel { xs:string }?, attribute usage { xs:string }?, (agent? & housename? & street? & poBox? & neighborhood? & city? & subregion? & region? & postcode? & country? & formattedAddress? ) }
ההגבלות
- אסור להשתמש ב-'gd:postalAddress' וגם ב-'gd:structuredPostalAddress' בישות אחת.
- אפשר לציין רק כתובת מובנית אחת כראשי.
- כתובת הדואר הלא מובנית חייבת להתאים לנתונים המובְנים.
gd:מתי
מייצג תקופת זמן או רגע.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@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>
. הפריט הראשון מזהה מקום באמצעות תיאור טקסט ו/או ערך איש קשר, בעוד השני מציין מקום באמצעות מיקום גיאוגרפי ספציפי.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@label ? |
xs:string |
מציינת תווית שניתנת לקריאה על ידי המשתמש כדי להבדיל בין המיקום הזה למיקומים אחרים. |
@rel ? |
xs:string |
המדיניות מציינת את הקשר בין הישות המכילה לבין המיקום שנכלל בה. ערכים אפשריים (ראו בהמשך) מוגדרים על ידי רכיבים אחרים. לדוגמה: <gd:when> מגדיר את http://schemas.google.com/g/2005#event . |
@valueString ? |
xs:string |
ערך מחרוזת פשוט שיכול לשמש כייצוג של המיקום הזה. |
gd:entryLink ? |
entryLink |
רשומה לייצוג פרטי המיקום. רשומה זו צריכה ליישם את הסוג של יצירת קשר. |
ערכי rel
ערך | תיאור |
---|---|
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>
כדי לציין שולחים ונמענים של אימייל, מארגני אירועים ביומן וכו'.
נכסים
מאפיין (property) | סוג | תיאור |
---|---|---|
@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
הערכים החוקיים עבור @rel תלויים בסוג הרכיב <gd:who>
.
ערך | סוג | תיאור |
---|---|---|
http://schemas.google.com/g/2005#event.attendee |
אירוע | משתתפים/משתתפים כלליים בפגישה |
http://schemas.google.com/g/2005#event.organizer |
אירוע | מארגן האירוע. מארגן הוא לא בהכרח משתתף. |
http://schemas.google.com/g/2005#event.performer |
אירוע | מבצע. דומה ל-http://schemas.google.com/g/2005#event.speaker , עם דגש רב יותר על אומנות מאשר דיבור. |
http://schemas.google.com/g/2005#event.speaker |
אירוע | רמקול. |
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 |
הודעה | נמען ראשי של הודעה. |
ערכי gd:attendeeType
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#event.optional |
משתתף אופציונלי. |
http://schemas.google.com/g/2005#event.required |
משתתף חובה. |
ערכי gd:attendeeStatus
ערך | תיאור |
---|---|
http://schemas.google.com/g/2005#event.accepted |
המשתתף/ת אישר/ה. |
http://schemas.google.com/g/2005#event.declined |
ההשתתפות נדחתה. |
http://schemas.google.com/g/2005#event.invited |
ההזמנה נשלחה, אבל האדם לא אישר. |
http://schemas.google.com/g/2005#event.tentative |
המשתתפים אישרו זמנית. |
דוגמאות
נמעני אימייל:
<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"/>
משתתף בפגישה:
<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>
מארגן האירוע:
<gd:who rel="http://schemas.google.com/g/2005#event.organizer" valueString="Receptionist 41"/>
סכימה
start = who who = element gd:who { gdCommonProperties, attribute rel { xs:string }?, attribute email { xs:string }?, attribute valueString { xs:string }?, (entryLink? & element gd:attendeeType { gEnumConstruct }? & element gd:attendeeStatus { gEnumConstruct }?) }
שינויים החל מגרסה 1.0
שינויים בסוג של איש הקשר
הרכיבים הבאים שאינם בגרסה 1.0 נוספו בגרסה 2.0 של סוג איש הקשר:
gd:name
gd:structuredPostalAddress
gd:where
סוגי הטלפונים הבאים שאינם קיימים בגרסה 1.0 נוספו בגרסה 2.0:
http://schemas.google.com/g/2005#assistant
http://schemas.google.com/g/2005#callback
http://schemas.google.com/g/2005#car
http://schemas.google.com/g/2005#company_main
http://schemas.google.com/g/2005#isdn
http://schemas.google.com/g/2005#main
http://schemas.google.com/g/2005#other_fax
http://schemas.google.com/g/2005#radio
http://schemas.google.com/g/2005#telex
http://schemas.google.com/g/2005#tty_tdd
http://schemas.google.com/g/2005#work_mobile
http://schemas.google.com/g/2005#work_pager
סוג ה-IM הבא שלא קיים בגרסה 1.0 נוסף בגרסה 2.0:
http://schemas.google.com/g/2005#netmeeting
האלמנטים הבאים מסוג איש קשר 1.0 אינם נתמכים יותר:
atom:title
— עדיין קיימות בערכים שהשרת החזיר, אך התעלמה מבקשותPUT
ו-POST
. הוחלף על ידיgd:name
.gd:postalAddress
– הוחלף על ידיgd:structuredPostalAddress
.
שינויים בgd:email
המאפיין החדש @displayName
נוסף אל gd:email
בשנת 2.0
שינויים בgd:organization
רכיבי המשנה הבאים של gd:organization
נוספו בגרסה 2.0:
gd:orgDepartment
gd:orgJobDescription
gd:orgSymbol
gd:where
שינויים בgd:orgName
בגרסה 2.0, הרכיב gd:orgName
שופר על ידי הוספת המאפיין @yomi
.