يوفر هذا المستند مستندات مرجعية مفصّلة للبروتوكول الأولي (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، تسمح واجهة برمجة التطبيقات لبيانات المواقع الإلكترونية بالمَعلمات الاختيارية التالية
التي تُصدر طلب GET
باستخدام خلاصة المحتوى:
المَعلمة | الوصف | النوع | Notes |
---|---|---|---|
ancestor |
يطلب فقط الإدخالات التي تحتوي على الأصل المحدد. | سلسلة | قدِّم رقم تعريف إدخال الأصل المطلوب. مثلاً: 0123456789 عرض جميع الإدخالات التي تحتوي على الأصل المحدد باعتباره أصلاً رئيسيًا، وأحد الوالدين لأحد الوالدين، وما إلى ذلك. |
include-deleted |
يحدد ما إذا كان سيتم تضمين الإدخالات المحذوفة. | boolean | القيمتان المحتملتان هما true أو false . الإعداد التلقائي هو false . |
include-draft |
يُحدِّد ما إذا كان سيتم تضمين مسودات الإدخالات. | boolean | القيمتان المحتملتان هما 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
لبيانات المواقع الإلكترونية:
المَعلمة | الوصف | النوع | Notes |
---|---|---|---|
include-all-sites |
يمكنك إدراج جميع المواقع الإلكترونية التي يمكن للمستخدم الاطّلاع عليها على الأقل في نطاق G Suite. | boolean | لا تسري هذه المعلمة إلا عند إدراج المواقع الإلكترونية لنطاق G Suite. القيمتان المسموح بإدراجهما هما true
أو false . الإعداد التلقائي هو false . |
with-mappings |
وتشمل عمليات ربط عنوان الويب في إدخال موقع إلكتروني. | boolean | القيمتان المحتملتان هما true أو false . الإعداد التلقائي هو false . |
خلاصة ACL
يمكن استخدام خلاصة ACL لسرد و/أو تعديل أذونات المشاركة (قوائم ACL) لموقع 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
(استعلامات نصية كاملة)
راجِع كل خلاصة أعلاه للاطّلاع على قائمة بالمعلَمات الخاصة بتلك الخلاصة.