توفّر واجهة برمجة التطبيقات لخدمة Search Console الخدمات التالية:
- إحصاءات البحث: لطلب بيانات الزيارات إلى موقعك الإلكتروني
- خرائط الموقع: يمكنك إدراج جميع خرائط الموقع وطلب الحصول على معلومات حول خريطة موقع معيّنة وإرسال خريطة الموقع إلى 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"]
} |
خرائط الموقع
لمعرفة تفاصيل موارد خرائط الموقع، يُرجى الاطّلاع على صفحة تمثيل الموارد.
| الطريقة | طلب HTTP | الوصف |
|---|---|---|
| معرّفات الموارد المنتظمة (URI) ذات الصلة بـ https://www.googleapis.com/webmasters/v3، ما لم يُذكر غير ذلك | ||
| حذف |
DELETE /sites/siteUrl/sitemaps/feedpath
|
يؤدي هذا الإجراء إلى حذف ملف خريطة الموقع من هذا الموقع الإلكتروني. |
| الحصول على |
GET /sites/siteUrl/sitemaps/feedpath
|
لاسترداد معلومات حول ملف خريطة موقع معين. |
| list |
GET /sites/siteUrl/sitemaps
|
يسرد sitemaps-entries الذي تم إرساله لهذا الموقع أو يتم تضمينه في ملف فهرسة خرائط الموقع (إذا تم تحديد sitemapIndex في الطلب).
|
| إرسال |
PUT /sites/siteUrl/sitemaps/feedpath
|
إرسال خريطة موقع لموقع إلكتروني |
مواقع Google الإلكترونية
لمعرفة تفاصيل موارد المواقع، يُرجى الاطّلاع على صفحة تمثيل المورد.
| الطريقة | طلب 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"} |