API Reference

Search Console API خدمات زیر را ارائه می دهد:

  • تجزیه و تحلیل جستجو - داده های ترافیک سایت خود را جستجو کنید.
  • نقشه سایت - تمام نقشه های سایت خود را فهرست کنید، اطلاعات مربوط به یک نقشه سایت خاص را درخواست کنید و نقشه سایت را به گوگل ارسال کنید.
  • سایت ها - لیست/افزودن/حذف ویژگی ها از حساب کنسول جستجوی شما.
  • بازرسی URL - وضعیت یک صفحه را در فهرست Google (معادل بازرسی URL در کنسول جستجو) بررسی کنید.

تجزیه و تحلیل جستجو

برای جزئیات منابع جستجوی تجزیه و تحلیل، به صفحه نمایش منبع مراجعه کنید.

روش درخواست HTTP توضیحات
URI های مربوط به https://www.googleapis.com/webmasters/v3، مگر اینکه خلاف آن ذکر شده باشد
پرس و جو POST /sites/ siteUrl /searchAnalytics/query

داده های ترافیک جستجوی خود را با فیلترها و پارامترهایی که شما تعریف می کنید پرس و جو کنید. این روش صفر یا چند ردیف را برمی گرداند که با کلیدهای ردیفی (ابعاد) که شما تعریف کرده اید، گروه بندی شده اند. شما باید محدوده تاریخ یک یا چند روزه را تعریف کنید.

هنگامی که تاریخ یکی از ابعاد است، هر روز بدون داده از لیست نتایج حذف می شود. برای اطلاع از اینکه چه روزهایی دارای داده هستند، درخواستی بدون فیلترهای گروه بندی شده بر اساس تاریخ، برای محدوده تاریخ مورد علاقه صادر کنید.

نتایج بر اساس تعداد کلیک های نزولی مرتب شده اند. اگر دو ردیف تعداد کلیک یکسانی داشته باشند، به روش دلخواه مرتب می شوند.

برای فراخوانی این روش به نمونه پایتون مراجعه کنید.

مثال 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 اطلاعات مربوط به یک نقشه سایت خاص را بازیابی می کند.
فهرست GET /sites/ siteUrl /sitemaps نقشه های سایت-مدخل های ارسال شده برای این سایت، یا در فایل فهرست نقشه سایت (در صورتی که sitemapIndex در درخواست مشخص شده باشد) را فهرست می کند.
ارسال کنید PUT /sites/ siteUrl /sitemaps/ feedpath یک نقشه سایت برای یک سایت ارسال می کند.

سایت ها

برای جزئیات منابع سایت، صفحه نمایش منبع را ببینید.

روش درخواست HTTP توضیحات
URI های مربوط به https://www.googleapis.com/webmasters/v3، مگر اینکه خلاف آن ذکر شده باشد
اضافه کردن PUT /sites/ siteUrl سایتی را به مجموعه سایت های کاربر در کنسول جستجو اضافه می کند.
حذف کنید DELETE /sites/ siteUrl یک سایت را از مجموعه سایت های کنسول جستجوی کاربر حذف می کند.
دریافت کنید GET /sites/ siteUrl اطلاعات مربوط به سایت خاصی را بازیابی می کند.
فهرست GET /sites سایت های کنسول جستجوی کاربر را فهرست می کند.

بازرسی URL

برای جزئیات منبع بازرسی URL، صفحه نمایش منبع را ببینید.

روش درخواست HTTP توضیحات
URI نسبت به https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

اطلاعات مربوط به URL ارائه شده در فهرست گوگل.

مثال 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"}