במסמך הזה תמצאו מסמכי עזר מפורטים לפרוטוקול הגולמי (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, ה-Google 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
(שאילתות טקסט מלא)
בכל פיד שלמעלה מופיעה רשימה של פרמטרים ספציפיים לפיד הזה.