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

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

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

مخاطب

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

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

انواع فید سایت‌های گوگل

API داده‌های سایت‌های گوگل انواع فیدهای زیر را ارائه می‌دهد:

فید فعالیت

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

آدرس اینترنتی 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

علاوه بر پارامترهای استاندارد پرس‌وجوی API داده، API داده‌های سایت‌ها به پارامترهای اختیاری زیر اجازه می‌دهد تا درخواست GET را با استفاده از فید محتوا صادر کنند:

پارامتر توضیحات نوع یادداشت‌ها
ancestor فقط ورودی‌هایی را درخواست می‌کند که جد مشخص‌شده را داشته باشند. رشته شناسه‌ی ورودی جد مورد نظر را ارائه دهید. برای مثال: 0123456789 تمام ورودی‌هایی را که جد مشخص شده را به عنوان والد، والدِ والد و غیره دارند، برمی‌گرداند.
include-deleted مشخص می‌کند که آیا ورودی‌های حذف‌شده را نیز شامل شود یا خیر. بولی مقادیر ممکن true یا false هستند. پیش‌فرض false است.
include-draft مشخص می‌کند که آیا ورودی‌های پیش‌نویس را شامل شود یا خیر. بولی مقادیر ممکن true یا false هستند. پیش‌فرض false است. برای مشاهده پیش‌نویس، باید مالک یا نویسنده آن باشید.
kind نوع(های) ورودی محتوا را برای بازگشت مشخص می‌کند. این ورودی‌ها از نوع صفحه در سایت‌های گوگل پیروی می‌کنند. فهرست رشته‌های جدا شده با کاما مقادیر ممکن عبارتند از: 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

فید سایت

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

آدرس فید (feed URI) برای فهرست سایت‌ها عبارت است از:

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) یک سایت گوگل استفاده شود.

آدرس فید (feed URI) برای فهرست سایت‌ها عبارت است از:

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

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

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

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

مرجع پارامترهای جستجوی سایت‌های گوگل

پارامترهای پرس و جوی پشتیبانی شده از پروتکل Google Data API :

  • max-results
  • published-max (فقط فید محتوا)
  • published-min (فقط فید محتوا)
  • start-index
  • updated-max
  • updated-min
  • q (پرس‌وجوهای متن کامل)

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

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