يوفّر هذا المستند مستندات مرجعية مفصّلة للبروتوكول الأولي (XML وHTTP) الخاص بـ "واجهة برمجة التطبيقات لبيانات مواقع Google".
لا يحتوي هذا المستند على معلومات حول مكتبات البرامج بلغات البرمجة. للحصول على معلومات مرجعية عن مكتبة البرامج، اطّلِع على الروابط من الأقسام الخاصة بلغة البرمجة في دليل المطوّر.
الجمهور
هذا المستند مخصّص للمبرمجين الذين يريدون كتابة تطبيقات عملاء يمكنها التفاعل مع "مواقع Google".
هذا المستند هو مستند مرجعي، ويفترض أنّك تفهم المفاهيم الواردة في دليل البروتوكول والأفكار العامة التي يستند إليها بروتوكول Google Data APIs.
أنواع خلاصات "مواقع Google"
توفّر Google Sites Data API الأنواع التالية من الخلاصات:
خلاصة الأنشطة
خلاصة "النشاط" هي خلاصة تحتوي على أوصاف لجميع الأنشطة داخل موقع إلكتروني.
عنوان URI الخاص بهذه الخلاصة لموقع إلكتروني ضمن نطاق معيّن هو:GET
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName هو إما "site" أو نطاق G Suite.
siteName هو اسم الموقع الإلكتروني كما يظهر في عنوان URL الخاص بالصفحة المقصودة للموقع الإلكتروني: http://sites.google.com/a/domainName/siteName/.
يجب أن تتم مصادقة جميع الطلبات المقدَّمة إلى هذه الخلاصة.
أنواع الطلبات المتوافقة: GET
خلاصة المحتوى
خلاصة المحتوى هي خلاصة تحتوي على محتوى الموقع الإلكتروني الحالي القابل للتعديل.
عنوان URI الخاص بهذه الخلاصة لموقع إلكتروني ضمن نطاق معيّن هو:GET
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". | قائمة سلاسل مفصولة بفواصل | القيم المحتمَلة هي 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 هو إما "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. |
خلاصة قائمة التحكم بالوصول
يمكن استخدام خلاصة قائمة التحكّم بالوصول لإدراج و/أو تعديل أذونات المشاركة (قوائم التحكّم بالوصول) الخاصة بموقع 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(طلبات البحث النصية الكاملة)
اطّلِع على كل خلاصة أعلاه للاطّلاع على قائمة بالمعلمات الخاصة بهذه الخلاصة.