Metoda entity.search

Wyszukuje w Grafie wiedzy jednostki pasujące do ograniczeń.

Żądanie HTTP

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

Parametry zapytania

Nazwa parametru	Typ	Opis
query	string	Ciąg literału do wyszukania w Grafie wiedzy.
ids	string	Lista identyfikatorów jednostek do wyszukania w Grafie wiedzy. Aby podać kilka identyfikatorów w żądaniu HTTP, powtórz parametr w polu Adres URL w postaci ...?ids=A&ids=B
languages	string	Lista kodów języków (zdefiniowanych w ISO 639), z którymi będzie wykonywane zapytanie, na przykład „en”.
types	string	Ogranicza zwracane elementy do określonych typów. Przykład: możesz określić atrybut „Person” (zgodnie z definicją na stronie http://schema.org/Person). aby ograniczyć wyniki do podmiotów reprezentujących osoby. Jeśli określisz wiele typów, zwrócone elementy będą zawierać co najmniej 1 z tych typów.
indent	boolean	Umożliwia wcięcie wyników w formacie JSON.
prefix	boolean	Umożliwia dopasowanie prefiksu (początkowego podłańcucha) do nazw i aliasów podmiotów. Na przykład prefiks „Jung” będzie pasować do encji i aliasów, takich jak jak „Jung”, „Jungle” i „Jung-ho Kang”.
limit	number	Ogranicza liczbę elementów do zwrócenia. Maksymalna liczba to 500. Wartość domyślna to 20. Żądania z wysokimi limitami mają większą szansę na przekroczenie limitu czasu.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią zawiera listę elementów przedstawianych w format JSON-LD i zgodny z Schematy schema.org (z ograniczoną liczbą rozszerzeń zewnętrznych).

Poniższy przykładowy kod 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 elementu.
name	string	Nazwa elementu.
@type	array	Lista obsługiwanych typów schema.org, które pasują do encji.
description	string	Krótki opis elementu.
image	URL	Obraz ułatwiający identyfikację elementu.
detailedDescription	string	Szczegółowy opis elementu.
url	URL	Adres URL oficjalnej strony internetowej podmiotu, jeśli jest dostępny.
resultScore	number	Wskaźnik pokazujący, w jakim stopniu element spełnia ograniczenia żądania.

Uwaga: podamy adresy URL obrazów, które pomogą Ci potwierdzić wybór właściwy element. Tak jak w przypadku wszystkich treści uzyskanych za pomocą interfejsów API Google, odpowiada za zapewnienie, że używasz obrazów zgodnie z obowiązującymi

Słowa kluczowe JSON-LD

W przypadku słów kluczowych JSON-LD, np. @context , @vocab, @type lub @id, poszukaj w sekcji Specyfikacja JSON-LD.

Zgodność ze standardem schema.org

Odpowiedź wykorzystuje słownictwo hostowane na stronie schema.org z ograniczonymi rozszerzeniami (na np. resultScore), które są zgodne ze słownikiem schema.org. Więcej informacji o tych rozszerzeniach znajdziesz na stronie Lista rozszerzeń schematu.

Dla każdego typu schema.org (takiego jak Person) i właściwości (takich jak name) ma odpowiedni pełny identyfikator URI, jak w tych przykładach:

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

• Rzecz -> http://schema.org/Thing

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

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

Typy i właściwości zdefiniowane jako rozszerzenia schematu Google można rozszerzono o http://schema.googleapis.com. Przykład:

• Wynik wyszukiwania encji -> http://schema.googleapis.com/EntitySearchResult
• szczegółowy opis -> http://schema.googleapis.com/detailedDescription

Dokumentacja poszczególnych typów i właściwości jest dostępna w odpowiadający identyfikatorowi URI.

Lista rozszerzeń schematu

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

Rozszerzenie schema.org typu type:

• EntitySearchResult

Rozszerzenia property w Schema.org to:

• detailedDescription
• resultScore