מדריך עזר

במסמך הזה תמצאו מסמכי עזר מפורטים לפרוטוקול הגולמי (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 ההגדרה קובעת אם לכלול רשומות שנמחקו. בוליאני הערכים האפשריים הם true או false. ברירת המחדל היא false.
include-draft ההגדרה קובעת אם לכלול רשומות טיוטה. בוליאני הערכים האפשריים הם true או false. ברירת המחדל היא false. צריך להיות הבעלים או המחבר של הטיוטה כדי לצפות בה.
kind מציינת את סוגי רשומות התוכן שיוחזרו. הן מתאימות לסוג הדפים ב-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 של הפיד לדף האפליקציה 'אתרים' הוא:

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

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

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

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

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

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

פיד ACL

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

ה-URI של הפיד לדף האפליקציה 'אתרים' הוא:

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 (שאילתות טקסט מלאות)

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

חזרה למעלה