API Reference

تقدّم واجهة برمجة تطبيقات Search Console الخدمات التالية:

  • إحصاءات البحث: بيانات طلبات البحث الخاصة بموقعك الإلكتروني
  • ملفات Sitemap: يمكنك إدراج جميع ملفات Sitemap وطلب معلومات حول ملف Sitemap معيّن وإرسال ملف Sitemap إلى Google.
  • مواقع Google - إدراج/إضافة/إزالة مواقع من حسابك في Search Console.
  • فحص عنوان URL - لفحص حالة صفحة في فهرس Google (تعادل فحص عنوان URL في Search Console).

إحصاءات البحث

للحصول على تفاصيل مورد إحصاءات البحث، راجع صفحة تمثيل المورد.

الطريقة طلب HTTP الوصف
مُعرِّفات الموارد المنتظمة (URI) المنطبقة على https://www.googleapis.com/webmasters/v3، ما لم يُذكر خلاف ذلك
طلب بحث POST  /sites/siteUrl/searchAnalytics/query

يمكنك إجراء طلب بحث عن بيانات زيارات البحث باستخدام الفلاتر والمعلمات التي تحددها. لا تعرض الطريقة أي صفوف أو أكثر مجمّعة حسب مفاتيح الصفوف (الأبعاد) التي تحدّدها. يجب تحديد نطاق زمني من يوم واحد أو أكثر.

عندما يكون التاريخ أحد الأبعاد، يتم حذف أي أيام بدون بيانات من قائمة النتائج. لمعرفة الأيام التي تشتمل على بيانات، يمكنك إصدار طلب بحث بدون فلاتر مجمّعة بحسب التاريخ للنطاق الزمني المطلوب.

يتم ترتيب النتائج حسب عدد النقرات تنازليًا. إذا كان هناك صفان لهما نفس عدد النقرات، يتم ترتيبهما بطريقة عشوائية.

يمكنك الاطّلاع على نموذج python لاستدعاء هذه الطريقة.

مثال على JSON POST: 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

خرائط الموقع

للحصول على تفاصيل مورد ملفات Sitemap، اطلع على صفحة تمثيل المورد.

الطريقة طلب HTTP الوصف
مُعرِّفات الموارد المنتظمة (URI) المنطبقة على https://www.googleapis.com/webmasters/v3، ما لم يُذكر خلاف ذلك
حذف DELETE  /sites/siteUrl/sitemaps/feedpath لحذف ملف Sitemap من هذا الموقع الإلكتروني.
الحصول GET  /sites/siteUrl/sitemaps/feedpath لاسترداد معلومات حول ملف sitemap معين.
list GET  /sites/siteUrl/sitemaps يسرد إدخالات ملفات Sitemap التي تم إرسالها لهذا الموقع الإلكتروني، أو المدرَجة في ملف فهرس Sitemap (إذا تم تحديد sitemapIndex في الطلب).
إرسال PUT  /sites/siteUrl/sitemaps/feedpath لإرسال ملف Sitemap لموقع إلكتروني.

مواقع

للحصول على تفاصيل مورد المواقع، راجع صفحة تمثيل المورد.

الطريقة طلب HTTP الوصف
مُعرِّفات الموارد المنتظمة (URI) المنطبقة على https://www.googleapis.com/webmasters/v3، ما لم يُذكر خلاف ذلك
إضافة PUT  /sites/siteUrl لإضافة موقع إلى مجموعة من مواقع المستخدم في Search Console.
حذف DELETE  /sites/siteUrl إزالة موقع من مجموعة مواقع Search Console للمستخدم.
الحصول GET  /sites/siteUrl لاسترداد معلومات حول موقع معين.
list GET  /sites يسرد مواقع Search Console للمستخدم.

فحص عنوان URL

للحصول على تفاصيل مورد "فحص عنوان URL"، يُرجى الاطّلاع على صفحة تمثيل المورد.

الطريقة طلب HTTP الوصف
عنوان URI مرتبط بـ https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

معلومات عن عنوان URL المقدَّم في فهرس Google

مثال على JSON POST: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}