מדריך עזר

מסמך זה מספק תיעוד עזר מפורט עבור הפרוטוקול הגולמי (XML ו-HTTP) עבור Google Sites Data API.

המסמך לא מכיל מידע על ספריות הלקוח בשפת התכנות. לקבלת מידע על ספריית הלקוח, עיינו בקישורים מהקטעים הספציפיים לשפת התכנות של המדריך למפתחים.

קהל

המסמך הזה מיועד למתכנתים שרוצים לכתוב אפליקציות לקוח שיכולות לקיים אינטראקציה עם Google Sites.

זהו מסמך עזר; ההנחה היא שאתה מבין את המושגים שמוצגים במדריך הפרוטוקולים ואת הרעיונות הכלליים שמאחורי פרוטוקול Google Data APIs.

סוגי פידים של Google Sites

ממשק ה-API של Google Sites Data מספק את סוגי העדכונים הבאים:

פיד הפעילות

פיד הפעילות הוא פיד שמכיל תיאורים של כל הפעילויות באתר.

ה-URI של הפיד GET עבור אתר בדומיין מסוים הוא:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName הוא "אתר" או דומיין G Suite.

siteName הוא שם האתר כפי שהוא מופיע בכתובת דף הנחיתה של האתר: http://sites.google.com/a/domainName/siteName/.

כל הבקשות לפיד הזה צריכות להיות מאומתות.

סוגי הבקשות הנתמכים: GET

פיד תוכן

עדכון התוכן הוא עדכון שמכיל את תוכן האתר הנוכחי שניתן לעריכה.

ה-URI של הפיד GET עבור אתר בדומיין מסוים הוא:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName הוא "אתר" או דומיין G Suite.

siteName הוא שם האתר כפי שהוא מופיע בכתובת דף הנחיתה של האתר: http://sites.google.com/a/domainName/siteName.

בקשות לפיד הזה עשויות לדרוש אימות וייתכן שלא, בהתאם להגדרות האתר (שפורסם).

סוגי הבקשות הנתמכים: GET, POST, PUT, DELETE

בנוסף לפרמטרים הרגילים של שאילתות ב-Data API, ה-Sites Data API מאפשר להשתמש בפרמטרים האופציונליים הבאים לשליחת בקשת GET באמצעות פיד התוכן:

פרמטר תיאור סוג הערות
ancestor היא מבקשת רק ערכים שיש להם ישות אב שצוינה. מחרוזת מספקים את המזהה של רשומת האב הרצויה. לדוגמה: 0123456789 מחזירה את כל הרשומות שבהן בעל האב שצוין הוא הורה, הורה וכן הלאה.
include-deleted ההגדרה קובעת אם לכלול רשומות שנמחקו. boolean הערכים האפשריים הם true או false. ברירת המחדל היא false.
include-draft קובעת אם לכלול רשומות טיוטה. boolean הערכים האפשריים הם true או false. ברירת המחדל היא false. כדי להציג את הטיוטה, עליך להיות הבעלים או המחבר שלה.
kind ציון הסוגים של ערכי תוכן שיוחזרו. כתובות ה-URL האלה בנויות לפי סוג הדף ב-Google Sites. רשימת מחרוזות מופרדות בפסיקים הערכים האפשריים הם announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent בקשות רק רשומות עם ההורה שצוין. מחרוזת מזינים את המזהה של רשומת ההורה. לדוגמה: 0123456789
path בקשות לתוכן בהיררכיית דפים מסוימת מחרוזת הנתיב לדף משנה באתר שעבורו רוצים לאחזר תוכן. לדוגמה: path=/path/to/page

פיד גרסאות

עדכון הגרסה הוא עדכון שמכיל גרסאות קודמות של תוכן האתר.

ה-URI של הפיד GET עבור אתר בדומיין מסוים הוא:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName הוא "אתר" או דומיין G Suite.

siteName הוא שם האתר כפי שהוא מופיע בכתובת דף הנחיתה של האתר: http://sites.google.com/a/domainName/siteName.

כל הבקשות לפיד הזה צריכות להיות מאומתות.

סוגי הבקשות הנתמכים: GET

פיד האתר

אפשר להשתמש בפיד האתר כדי לציין את רשימת האתרים ב-Google Sites שבבעלות משתמש או שיש לו הרשאות צפייה. אפשר להשתמש בו גם כדי ליצור אתרים חדשים, להעתיק אתר או לשנות שם של אתר קיים.

ה-URI של העדכון עבור הרישום ב-Google Sites הוא:

https://sites.google.com/feeds/site/domainName/[siteName]

domainName הוא "אתר" או דומיין G Suite.

כל הבקשות לפיד הזה צריכות להיות מאומתות.

סוגי הבקשות הנתמכים: GET, POST, PUT

עדכון האתר תומך בפרמטרים הבאים (אופציונליים) בעת שליחת בקשה GET לפירוט אתרים:

פרמטר תיאור סוג הערות
include-all-sites רשימה של כל האתרים שלפחות משתמש בדומיין G Suite יכול לצפות בהם. boolean הפרמטר הזה רלוונטי רק לפירוט אתרים של דומיין ב-G Suite. הערכים האפשריים הם true או false. ברירת המחדל היא false.
with-mappings כולל מיפויים של כתובות אינטרנט ברשומת אתר. boolean הערכים האפשריים הם true או false. ברירת המחדל היא false.

פיד ACL

ניתן להשתמש בעדכון ה-ACL כדי להציג ו/או לשנות את הרשאות השיתוף (ACL) של אתר שנוצר באמצעות Google Sites.

ה-URI של העדכון עבור הרישום ב-Google Sites הוא:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName הוא "אתר" או דומיין G Suite.

כל הבקשות לפיד הזה צריכות להיות מאומתות.

סוגי הבקשות הנתמכים: GET, POST, PUT, DELETE

הפניות לפרמטרים של שאילתות ב-Google Sites

פרמטרים נתמכים של שאילתות מהפרוטוקול Google Data API:

  • max-results
  • published-max (פיד תוכן בלבד)
  • published-min (פיד תוכן בלבד)
  • start-index
  • updated-max
  • updated-min
  • q (שאילתות טקסט מלאות)

בכל פיד שלמעלה יש רשימה של פרמטרים ספציפיים לאותו פיד.

חזרה למעלה