دليل مرجعي

يقدم هذا المستند وثائق مرجعية مفصلة عن البروتوكول الأولي (XML وHTTP) الخاص بواجهة برمجة التطبيقات لبيانات مواقع Google.

لا يحتوي هذا المستند على معلومات عن مكتبات عملاء لغة البرمجة. للحصول على المعلومات المرجعية لمكتبة العملاء، يمكنك الاطّلاع على الروابط من الأقسام الخاصة بلغة البرمجة في دليل المطوّر.

الجمهور

هذا المستند مخصص للمبرمجين الذين يريدون كتابة تطبيقات العميل التي يمكنها التفاعل مع مواقع Google.

إنها وثيقة مرجعية؛ يفترض أنك تفهم المفاهيم الواردة في دليل البروتوكول، والأفكار العامة وراء بروتوكول Google Data APIs.

أنواع خلاصات "مواقع Google"

توفّر واجهة برمجة التطبيقات للبيانات في "مواقع Google" الأنواع التالية من الخلاصات:

خلاصة الأنشطة

خلاصة الأنشطة هي خلاصة تحتوي على أوصاف لجميع الأنشطة ضمن موقع إلكتروني.

معرّف الموارد المنتظم (URI) الخاص بالخلاصة GET لموقع إلكتروني ضمن نطاق معيّن هو:

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

domainName إما "موقع إلكتروني" أو نطاق G Suite.

siteName هو اسم الموقع الإلكتروني كما يظهر في عنوان URL للصفحة المقصودة للموقع الإلكتروني: http://sites.google.com/a/domainName/siteName/.

يجب المصادقة على جميع الطلبات المُرسَلة إلى هذه الخلاصة.

أنواع الطلبات المتوافقة: GET

خلاصة المحتوى

خلاصة المحتوى هي خلاصة تتضمن محتوى الموقع الإلكتروني الحالي القابل للتعديل.

معرّف الموارد المنتظم (URI) الخاص بالخلاصة GET لموقع إلكتروني ضمن نطاق معيّن هو:

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

domainName إما "موقع إلكتروني" أو نطاق G Suite.

siteName هو اسم الموقع الإلكتروني كما يظهر في عنوان URL للصفحة المقصودة للموقع: http://sites.google.com/a/domainName/siteName.

استنادًا إلى إعدادات الموقع الإلكتروني (المنشورة)، قد تتم المصادقة على الطلبات المقدَّمة إلى هذه الخلاصة أو لا تتطلّب المصادقة.

أنواع الطلبات المتوافقة: GET وPOST وPUT وDELETE

بالإضافة إلى معلَمات طلب البحث العادية في Data API، تتيح واجهة برمجة التطبيقات Site Data API استخدام المَعلمات الاختيارية التالية. إصدار طلب "GET" باستخدام خلاصة المحتوى:

المعلمة الوصف النوع ملاحظات
ancestor تطلب فقط الإدخالات التي لها الأصل المحدد. سلسلة قدِّم رقم تعريف إدخال الأصل المطلوب. مثلاً: 0123456789 تعرض جميع الإدخالات التي تضم الأصل المحدد باعتباره أصلاً وأصل أحد الوالدين وما إلى ذلك.
include-deleted تحدِّد هذه السياسة ما إذا كان سيتم تضمين الإدخالات المحذوفة. منطقي القيم المحتملة هي true أو false. القيمة التلقائية هي false.
include-draft تحدِّد هذه السياسة ما إذا كان سيتم تضمين مسودة الإدخالات. منطقي القيم المحتملة هي true أو false. القيمة التلقائية هي false. يجب أن تكون المالك أو المؤلف من المسودة لمشاهدته.
kind لتحديد أنواع إدخالات المحتوى المطلوب عرضها. وهي تتبع نوع الصفحة في "مواقع Google". قائمة السلاسل المفصولة بفواصل القيم المحتملة هي 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 هو اسم الموقع الإلكتروني كما يظهر في عنوان URL للصفحة المقصودة للموقع: http://sites.google.com/a/domainName/siteName.

يجب المصادقة على جميع الطلبات المُرسَلة إلى هذه الخلاصة.

أنواع الطلبات المتوافقة: GET

خلاصة الموقع الإلكتروني

يمكن استخدام خلاصة الموقع لسرد مواقع Google التي يملكها المستخدم أو لديه أذونات عرض لها. يمكن أيضًا أن يكون يُستخدم لإنشاء مواقع إلكترونية جديدة أو نسخ موقع إلكتروني أو تعديل اسم موقع إلكتروني حالي.

معرّف الموارد المنتظم (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 لسرد و/أو تعديل أذونات المشاركة (ACLs) لموقع Google.

معرّف الموارد المنتظم (URI) لخلاصة قائمة المواقع هو:

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

domainName إما "موقع إلكتروني" أو نطاق G Suite.

يجب المصادقة على جميع الطلبات المُرسَلة إلى هذه الخلاصة.

أنواع الطلبات المتوافقة: GET وPOST وPUT وDELETE

مرجع مَعلمات طلب البحث في "مواقع Google"

معلَمات طلب البحث المتوافقة من بروتوكول Google Data API:

  • max-results
  • published-max (خلاصة المحتوى فقط)
  • published-min (خلاصة المحتوى فقط)
  • start-index
  • updated-max
  • updated-min
  • q (طلبات البحث النصية الكاملة)

اطّلِع على كل خلاصة أعلاه للاطّلاع على قائمة بالمَعلمات الخاصة بتلك الخلاصة.

الرجوع إلى الأعلى