راهنمای مرجع، راهنمای مرجع

این سند مستندات مرجع دقیق برای پروتکل خام (XML و HTTP) برای Google Sites Data API ارائه می دهد.

این سند حاوی اطلاعاتی درباره کتابخانه های کلاینت زبان برنامه نویسی نیست. برای اطلاعات مرجع کلاینت-کتابخانه، پیوندهای بخش‌های زبان برنامه‌نویسی راهنمای توسعه‌دهنده را ببینید.

مخاطب

این سند برای برنامه نویسانی در نظر گرفته شده است که می خواهند برنامه های مشتری بنویسند که می توانند با Google Sites تعامل داشته باشند.

این یک سند مرجع است. فرض بر این است که مفاهیم ارائه شده در راهنمای پروتکل و ایده های کلی پشت پروتکل Google Data APIs را درک می کنید.

انواع فید Google Sites

Google Sites Data API انواع زیر را ارائه می دهد:

فید فعالیت

فید Activity یک فید حاوی توضیحات تمام فعالیت‌های یک سایت است.

GET URI این فید برای یک سایت در یک دامنه خاص است:

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

domainName یا "site" است یا یک دامنه G Suite.

siteName نام سایت است همانطور که در URL صفحه فرود سایت ظاهر می شود: http://sites.google.com/a/ domainName / siteName /.

همه درخواست‌های این فید باید احراز هویت شوند.

انواع درخواست های پشتیبانی شده: GET

خوراک محتوا

فید محتوا یک فید حاوی محتوای فعلی و قابل ویرایش سایت است.

GET URI این فید برای یک سایت در یک دامنه خاص است:

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

domainName یا "site" است یا یک دامنه G Suite.

siteName نام سایت است همانطور که در URL صفحه فرود سایت ظاهر می شود: 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 .

فید تجدید نظر

فید Revision یک فید حاوی بازبینی‌های تاریخی محتوای سایت است.

GET URI این فید برای یک سایت در یک دامنه خاص است:

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

domainName یا "site" است یا یک دامنه G Suite.

siteName نام سایت است همانطور که در URL صفحه فرود سایت ظاهر می شود: http://sites.google.com/a/ domainName / siteName .

همه درخواست‌های این فید باید احراز هویت شوند.

انواع درخواست های پشتیبانی شده: GET

فید سایت

از فید سایت می توان برای فهرست کردن سایت های Google که یک کاربر مالک آن است یا مجوز مشاهده آنها را دارد استفاده کرد. همچنین می توان از آن برای ایجاد سایت های جدید، کپی کردن یک سایت یا تغییر نام یک سایت موجود استفاده کرد.

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 استفاده شود.

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 (پرسش های متنی کامل)

برای فهرستی از پارامترهای خاص آن فید، هر فید را در بالا ببینید.

بازگشت به بالا