מדריך עזר

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

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

קהל

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

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

סוגי פידים ב-Google Sites

‫Google Sites Data API מספק פידים מהסוגים הבאים:

פיד הפעילות

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

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

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

‫domainName הוא 'site' או דומיין G Suite.

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

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

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

פיד תוכן

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

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

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

‫domainName הוא 'site' או דומיין 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 הוא 'site' או דומיין G Suite.

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

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

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

פיד האתר

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

כתובת ה-URI של הפיד של כרטיסי המוצר של אתרים היא:

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

‫domainName הוא 'site' או דומיין G Suite.

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

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

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

פרמטר תיאור סוג הערות
include-all-sites רשימה של כל האתרים שהמשתמש יכול לפחות לצפות בהם בדומיין 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 הוא 'site' או דומיין G Suite.

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

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

חומרי עזר לפרמטרים של שאילתות ב-Google Sites

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

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

ברשימה שלמעלה מפורטים הפרמטרים שרלוונטיים לכל פיד.

חזרה למעלה