Обновления API Search Console

Среда, 9 декабря 2020 г.

Несколько месяцев назад мы сообщили о том, что планируем обновить инфраструктуру API, чтобы повысить производительность Search Console API. Сегодня мы расскажем вам о других новинках, которые планируем внедрить в нашем сервисе. Вот они:

  • Новые параметры Search Console API, позволяющие получать предварительные данные, а также данные о трафике с вкладки "Новости".
  • Поддержка доменных ресурсов в Sitemaps API.
  • Руководство по переносу документа Discovery.

Если вы используете собственные запросы к API, прочтите эту статью.

Новые параметры Search Console API, позволяющие получать предварительные данные, а также данные о трафике с вкладки "Новости"

Отчет об эффективности уже позволяет просматривать предварительные данные, полученные за последние сутки. Теперь получать такие данные можно и через API. Если вы добавите в запрос параметр dataState со значением all, то получите все данные, включая предварительные. Если вам нужны только обработанные данные, передавайте параметр со значением final или вообще не используйте его (обработанные данные возвращаются по умолчанию).

Несколько месяцев назад мы добавили возможность выбирать в отчетах об эффективности данные, относящиеся к вкладке "Новости" в Google Поиске. Эта информация теперь доступна с помощью API. Чтобы ее получить, назначьте параметру searchType в запросе значение news.

Поддержка доменных ресурсов в Sitemaps API

Sitemaps API теперь может работать с доменными ресурсами, как и другие Search Console API. Вы можете запрашивать, добавлять и удалять карты сайта для доменных ресурсов. Пример:

GET https://www.googleapis.com/webmasters/v3/sites/sc-domain:example.com/sitemaps

Перенос документа Discovery

Поддержка документов Discovery для Webmasters API будет прекращена. Если вы работаете с Search Console API через внешнюю библиотеку API или выполняете запросы к документу Discovery для Webmasters API напрямую, вам нужно будет обновить запросы к API с учетом описанных ниже изменений.

Изменения в библиотеке API

Чтобы узнать, что изменится в библиотеке API, изучите краткие руководства по Java и Python. В них уже обновлена информация о работе с API.

Java

При импорте любых данных Webmasters вместо названия пакета webmasters нужно использовать searchconsole.v1, а вместо Webmasters – SearchConsole. Примеры

  • Импорт сервиса API:

    import com.google.api.services.webmasters.Webmasters;

    import com.google.api.services.searchconsole.v1.SearchConsole;

  • Импорт объекта из ответа:

    import com.google.api.services.webmasters.model.WmxSite;

    import com.google.api.services.searchconsole.v1.model.WmxSite;

Обратите внимание, что как объект сервиса, так и остальные объекты API остались прежними, изменилось только название пакета.

Python

При создании объекта для Webmasters меняется следующее:

webmasters_service = build('webmasters', 'v3', http=http)

webmasters_service = build('searchconsole', 'v1', http=http)

Ещё раз отметим, что объекты работают по прежним алгоритмам.

Прямые запросы к документу Discovery

В запросы к документу Discovery меняются следующим образом:

  • Изменения в URL:

    https://www.googleapis.com/discovery/v1/apis/webmasters/v3/rest

    https://searchconsole.googleapis.com/$discovery/rest

  • Изменения в контенте:
    • Значение поля name изменено с webmasters на searchconsole.
    • Значение поля version изменено с v3 на v1.

Если у вас остались вопросы, их можно задать на справочном форуме Центра Google Поиска или в Твиттере.