Zmiany dotyczące interfejsu API Search Console

Środa, 9 grudnia 2020 r.

Kilka miesięcy temu zapowiedzieliśmy uaktualnienie infrastruktury interfejsu API mające na celu zwiększenie wydajności interfejsu Search Console API w związku z coraz większym zainteresowaniem użytkowników. Dziś z przyjemnością ogłaszamy kolejne nadchodzące zmiany:

  • dodanie nowego filtra aktualnych danych i wiadomości w interfejsie Search Console API,
  • obsługa usług domeny w interfejsie Sitemaps API,
  • wskazówki na temat migracji dokumentu opisującego.

Czytaj dalej, jeśli tworzysz własne wywołania interfejsu API.

Nowy filtr aktualnych danych i wiadomości w interfejsie Search Console API

Raport skuteczności obsługuje już aktualne dane, które mają mniej niż 1 dzień. Możesz teraz wyświetlać te dane poprzez interfejs API, używając parametru dataState z wartością ustawioną na all. Dane wyświetlone na podstawie tej wartości będą obejmować dane najnowsze, które nie są jeszcze ostateczne. Jeśli chcesz zobaczyć tylko dane ostateczne, możesz przesłać ten parametr, ustawiając wartość final, lub w ogóle go nie przesyłać – wówczas domyślnie otrzymasz tylko dane ostateczne.

Kilka miesięcy temu dodaliśmy do raportu skuteczności filtr Karta Wiadomości w wyszukiwarce. Te informacje są teraz dostępne również w interfejsie API. Aby je wyświetlić, wystarczy ustawić w żądaniu wartość parametru searchType na news.

Obsługa usług domeny w interfejsie Sitemaps API

Interfejs Sitemaps API obsługuje teraz usługi domeny, podobnie jak inne interfejsy API Search Console. Możesz dodawać i usuwać mapy witryn w usługach domeny oraz wysyłać zapytania na ich temat, na przykład:

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

Migracja dokumentu opisującego

Wycofujemy pomoc w dokumencie opisującym Webmasters API. Jeśli wysyłasz zapytania do interfejsu Search Console API przy użyciu zewnętrznej biblioteki API lub wysyłasz zapytania bezpośrednio do dokumentu opisującego Webmasters API, musisz zaktualizować wywołania interfejsu API, uwzględniając poniższe zmiany.

Zmiany w bibliotece interfejsu API

Informacje o zmianach w bibliotece interfejsu API znajdziesz w krótkich przewodnikach po językach Java i Python.

Java

W przypadku wszystkich importów związanych z usługami dla webmasterów zmień pakiet webmasters na searchconsole.v1, a nazwę usługi Webmasters na SearchConsole. Przykłady:

  • Importowanie usługi API:

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

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

  • Importowanie obiektu odpowiedzi:

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

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

Pamiętaj, że oprócz obiektu usługi inne obiekty API są dokładnie takie same jak wcześniej – zmienia się tylko pakiet.

Python

Podczas tworzenia obiektu usługi dla webmasterów zastosuj te zmiany:

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

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

W tym przypadku także zachowanie obiektów się nie zmienia.

Zapytania wysyłane bezpośrednio do dokumentu opisującego

Zmiany dotyczące wysyłania zapytań do dokumentu opisującego to między innymi:

  • Zmiana adresu URL

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

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

  • Zmiana treści
    • Wartość pola name zmieniła się z webmasters na searchconsole.
    • Wartość pola version zmieniła się z v3 na v1.

Jeśli masz pytania, zadaj je na forach pomocy Centrum wyszukiwarki lub na Twitterze.

Autorzy: Nati Yosephian, Gilad Amar i Michael Huzman z zespołu Search Console