Metoda entity.search

Przeszukuje Graf wiedzy pod kątem elementów zgodnych z ograniczeniami.

Żądanie HTTP

GET https://kgsearch.googleapis.com/v1/entities:search

Parametry zapytania

Nazwa parametru	Typ	Opis
query	string	Dosłowny ciąg znaków do wyszukania w Grafie wiedzy.
ids	string	Lista identyfikatorów jednostek do wyszukania w Grafie wiedzy. Aby podać wiele identyfikatorów w żądaniu HTTP, powtórz parametr w adresie URL, jak w przykładzie: ...?ids=A&ids=B
languages	string	Lista kodów języków (zdefiniowanych w normie ISO 639), za pomocą których uruchomi się zapytanie, np. „en”.
types	string	Ogranicza zwrócone encje do encji określonego typu. Możesz na przykład określić atrybut „Person” (zgodnie z definicją na stronie http://schema.org/Person), aby ograniczyć wyniki do elementów reprezentujących osoby. Jeśli określisz wiele typów, zwracane encje będą zawierać co najmniej jeden z tych typów.
indent	boolean	Umożliwia wcięcie wyników JSON.
prefix	boolean	Umożliwia dopasowanie prefiksu (początkowego podłańcucha) do nazw i aliasów encji. Na przykład prefiks „Jung” będzie pasować do encji i aliasów, takich jak „Jung”, „Dżungla” i „Jung-ho Kang”.
limit	number	Ogranicza liczbę encji, które mają zostać zwrócone. Maksymalna wartość to 500. Wartość domyślna to 20. Żądania z dużymi limitami mają większą szansę na przekroczenie limitu czasu.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią zawiera listę encji w formacie JSON-LD i zgodnym ze schematami schema.org (z ograniczoną liczbą rozszerzeń zewnętrznych).

Ten przykład JSON-LD pokazuje strukturę treści odpowiedzi:

{
  "@context": {
    "@vocab": "http://schema.org/",
    "goog": "http://schema.googleapis.com/",
    "resultScore": "goog:resultScore",
    "detailedDescription": "goog:detailedDescription",
    "EntitySearchResult": "goog:EntitySearchResult",
    "kg": "http://g.co/kg"
  },
  "@type": "ItemList",
  "itemListElement": [
    {
      "@type": "EntitySearchResult",
      "result": {
        "@id": "kg:/m/0dl567",
        "name": "Taylor Swift",
        "@type": [
          "Thing",
          "Person"
        ],
        "description": "Singer-songwriter",
        "image": {
          "contentUrl": "https://t1.gstatic.com/images?q=tbn:ANd9GcQmVDAhjhWnN2OWys2ZMO3PGAhupp5tN2LwF_BJmiHgi19hf8Ku",
          "url": "https://en.wikipedia.org/wiki/Taylor_Swift",
          "license": "http://creativecommons.org/licenses/by-sa/2.0"
        },
        "detailedDescription": {
          "articleBody": "Taylor Alison Swift is an American singer-songwriter and actress. Raised in Wyomissing, Pennsylvania, she moved to Nashville, Tennessee, at the age of 14 to pursue a career in country music. ",
          "url": "http://en.wikipedia.org/wiki/Taylor_Swift",
          "license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License"
        },
        "url": "http://taylorswift.com/"
      },
      "resultScore": 4850
    }
  ]
}

Pola odpowiedzi

Nazwa pola	Typ	Opis
@id	string	Kanoniczny identyfikator URI jednostki.
name	string	Nazwa elementu.
@type	array	Lista obsługiwanych typów schema.org, które pasują do elementu.
description	string	Krótki opis elementu.
image	URL	Obraz, który pomoże zidentyfikować element.
detailedDescription	string	Szczegółowy opis elementu.
url	URL	Adres URL oficjalnej strony internetowej podmiotu, jeśli jest dostępny.
resultScore	number	Wskaźnik zgodności elementu z ograniczeniami żądań.

Uwaga: podajemy adresy URL obrazów, aby pomóc Ci w potwierdzeniu wyboru właściwego elementu. Podobnie jak w przypadku wszystkich treści uzyskiwanych przy użyciu interfejsów API Google, ponosisz odpowiedzialność za używanie obrazów zgodnie z obowiązującym prawem.

Słowa kluczowe JSON-LD

W przypadku słów kluczowych w formacie JSON-LD, takich jak @context, @vocab, @type lub @id, zapoznaj się ze specyfikacją JSON-LD.

Zgodność ze schema.org

Odpowiedź wykorzystuje słownik ze strony schema.org z ograniczonymi rozszerzeniami (np. resultScore), które są zgodne ze słownikiem schema.org. Więcej informacji o tych rozszerzeniach znajdziesz na liście rozszerzeń schematów.

Dla każdego typu schema.org (np. Person) i jego właściwości (np. name) jest przypisany pełny identyfikator URI, jak w tych przykładach:

• Osoba -> http://schema.org/Person

• Thing –> http://schema.org/Thing

• nazwa -> http://schema.org/name

• description -> http://schema.org/description

Typy i właściwości zdefiniowane jako rozszerzenia schematu Google można rozwijać za pomocą adresu http://schema.googleapis.com. Na przykład

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• detailsDescription -> http://schema.googleapis.com/detailedDescription

Dokumentacja poszczególnych typów i właściwości jest dostępna pod odpowiednim identyfikatorem URI.

Lista rozszerzeń schematu

Rozszerzenia schematu używane w tym interfejsie API są hostowane na http://schema.googleapis.com jako rozszerzenia zewnętrzne.

Rozszerzenie type Schema.org to:

• EntitySearchResult

Rozszerzenia property Schema.org to:

• detailedDescription
• resultScore