يوفّر هذا المستند مستندات مرجعية مفصّلة للبروتوكول الأوّلي (XML وHTTP) لواجهة برمجة التطبيقات Google Sites Data API.
لا يحتوي هذا المستند على معلومات عن مكتبات البرامج الخاصة بلغات البرمجة. للحصول على معلومات مرجعية عن مكتبة العميل، اطّلِع على الروابط الواردة في الأقسام الخاصة بلغة البرمجة في دليل المطوّر.
الجمهور
هذا المستند مخصص للمبرمجين الذين يريدون كتابة تطبيقات العميل التي يمكنها التفاعل مع مواقع Google.
هذا المستند مرجعي، ويفترض أنّك تفهم المفاهيم الواردة في دليل البروتوكول والأفكار العامة التي تستند إليها بروتوكول Google Data APIs.
أنواع خلاصات "مواقع Google"
توفّر Google Sites Data API الأنواع التالية من الخلاصات:
خلاصة الأنشطة
خلاصة "النشاط" هي خلاصة تحتوي على أوصاف جميع الأنشطة ضمن موقع إلكتروني.
عنوان GET URI الخاص بهذه الخلاصة لموقع إلكتروني ضمن نطاق معيّن هو:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName إما "موقع إلكتروني" أو نطاق G Suite.
siteName هو اسم الموقع الإلكتروني كما يظهر في عنوان URL لصفحته المقصودة: http://sites.google.com/a/domainName/siteName/.
يجب مصادقة جميع الطلبات التي يتم إرسالها إلى هذه الخلاصة.
أنواع الطلبات المتوافقة: GET
خلاصة المحتوى
خلاصة "المحتوى" هي خلاصة تحتوي على محتوى الموقع الإلكتروني الحالي القابل للتعديل.
عنوان GET URI الخاص بهذه الخلاصة لموقع إلكتروني ضمن نطاق معيّن هو:
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، تتيح Sites 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. |
خلاصة المراجعات
خلاصة التنقيح هي خلاصة تحتوي على النُسخ السابقة من محتوى الموقع.
عنوان GET URI الخاص بهذه الخلاصة لموقع إلكتروني ضمن نطاق معيّن هو:
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 هو إما "site" أو نطاق G Suite.
يجب المصادقة على جميع الطلبات المُرسَلة إلى هذه الخلاصة.
أنواع الطلبات المتوافقة: GET وPOST وPUT
تتيح خلاصة المواقع الإلكترونية استخدام المَعلمات (الاختيارية) التالية عند إصدار طلب GET لإضافة المواقع الإلكترونية:
| المَعلمة | الوصف | النوع | ملاحظات |
|---|---|---|---|
include-all-sites |
أدرِج جميع المواقع الإلكترونية التي يمكن للمستخدم عرضها على الأقل في نطاق G Suite. | قيمة منطقية | لا تنطبق هذه المَعلمة إلا عند إدراج المواقع الإلكترونية لنطاق G Suite. القيم المحتملة هي true
أو false. القيمة التلقائية هي false. |
with-mappings |
يتضمّن عمليات ربط عناوين الويب في إدخال موقع إلكتروني. | قيمة منطقية | القيم المحتملة هي true أو false. القيمة التلقائية هي false. |
خلاصة ACL
يمكن استخدام خلاصة قائمة أذونات الوصول (ACL) لعرض و/أو تعديل أذونات المشاركة (قوائم أذونات الوصول) لموقع إلكتروني على Google.
معرّف الموارد المنتظم (URI) لخلاصة قائمة المواقع هو:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName هو إما "site" أو نطاق G Suite.
يجب المصادقة على جميع الطلبات المُرسَلة إلى هذه الخلاصة.
أنواع الطلبات المتوافقة: GET وPOST وPUT وDELETE
مرجع مَعلمات طلب البحث في "مواقع Google"
مَعلمات طلبات البحث المتوافقة من بروتوكول Google Data API:
max-resultspublished-max(خلاصة المحتوى فقط)published-min(خلاصة المحتوى فقط)start-indexupdated-maxupdated-minq(طلبات البحث النصية الكاملة)
اطّلِع على كل خلاصة أعلاه للحصول على قائمة بالمَعلمات الخاصة بهذه الخلاصة.