راهنمای مرجع

این سند مستندات مرجع مفصلی برای پروتکل خام (XML و HTTP) برای «میانای برنامه‌سازی کاربردی داده‌های Google Sites» ارائه می‌دهد.

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

مخاطبان

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

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

انواع فید Google Sites

«میانای برنامه‌سازی کاربردی داده‌های Google Sites» انواع فید زیر را ارائه می‌دهد:

جارزن فعالیت‌ها

«فید فعالیت‌ها» فیدی است که حاوی شرح همه فعالیت‌های درون سایت است.

‫GET نشانی وب این فید برای سایتی در دامنه‌ای خاص عبارت است از:

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

‫domainName یا «سایت» است یا دامنه G Suite.

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

همه درخواست‌های این فید باید اصالت‌سنجی شوند.

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

فید محتوا

«فید محتوا» فیدی است که حاوی محتوای کنونی و ویرایش‌شدنی سایت است.

‫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

علاوه‌بر پارامترهای پُرسمان «میانای برنامه‌سازی کاربردی داده‌های» استاندارد، «میانای برنامه‌سازی کاربردی داده‌های سایت‌ها» پارامترهای اختیاری زیر را برای صدور درخواست 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.

فید ویرایش

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

‫GET نشانی وب این فید برای سایتی در دامنه‌ای خاص عبارت است از:

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

‫domainName یا «سایت» است یا دامنه G Suite.

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

همه درخواست‌های این فید باید اصالت‌سنجی شوند.

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

فید سایت

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

نشانی وب فید برای فهرستگان «سایت‌ها» این است:

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

‫domainName یا «سایت» است یا دامنه 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» استفاده کرد.

نشانی وب فید برای فهرستگان «سایت‌ها» این است:

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

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

برگشتن به بالا