Método entities.search

Pesquisa no Mapa de informações entidades que correspondem às restrições.

Solicitação HTTP

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

Parâmetros de consulta

Nome do parâmetro	Tipo	Descrição
query	string	Uma string literal para pesquisar no Mapa de informações.
ids	string	Uma lista de IDs de entidades para pesquisar no Mapa de informações. Para especificar vários IDs na solicitação HTTP, repita o parâmetro no URL, como em ...?ids=A&ids=B
languages	string	A lista de códigos de idioma (definidos na ISO 639) para executar a consulta, por exemplo, "en".
types	string	Restringe as entidades retornadas àquelas dos tipos especificados. Por exemplo, é possível especificar "Person" (conforme definido em http://schema.org/Person) para restringir os resultados a entidades que representam pessoas. Se vários tipos forem especificados, as entidades retornadas vão conter um ou mais deles.
indent	boolean	Permite o recuo dos resultados JSON.
prefix	boolean	Ativa a correspondência de prefixo (substring inicial) com nomes e aliases de entidades. Por exemplo, o prefixo "Jung" vai corresponder a entidades e aliases como "Jung", "Jungle" e "Jung-ho Kang".
limit	number	Limita o número de entidades a serem retornadas. O máximo é 500. O padrão é 20. As solicitações com limites altos têm mais chances de atingir o tempo limite.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma mensagem de resposta contém uma lista de entidades, apresentada no formato JSON-LD e compatível com esquemas do schema.org (com extensões externas limitadas).

O exemplo de JSON-LD a seguir mostra como o corpo da resposta é estruturado:

{
  "@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
    }
  ]
}

Campos de resposta

Nome do campo	Tipo	Descrição
@id	string	O URI canônico da entidade.
name	string	É o nome da entidade.
@type	array	A lista de tipos compatíveis de schema.org que correspondem à entidade.
description	string	Uma breve descrição da entidade.
image	URL	Uma imagem para ajudar a identificar a entidade.
detailedDescription	string	Uma descrição detalhada da entidade.
url	URL	O URL do site oficial da entidade, se disponível.
resultScore	number	Um indicador de como a entidade correspondeu às restrições da solicitação.

Observação: os URLs de imagem são fornecidos para ajudar você a confirmar se selecionou a entidade correta. Assim como todo o conteúdo que você recebe pelas APIs do Google, você é responsável por garantir que o uso das imagens esteja em conformidade com a legislação aplicável.

Palavras-chave JSON-LD

Para palavras-chave JSON-LD, como @context , @vocab, @type ou @id, consulte a especificação JSON-LD.

Compatibilidade com schema.org

A resposta usa o vocabulário hospedado em schema.org, com extensões limitadas (por exemplo, resultScore) compatíveis com o vocabulário do schema.org. Para mais detalhes sobre essas extensões, consulte Lista de extensões de esquema.

Para cada um dos tipos (como Person) e propriedades (como name) do Schema.org, há um URI completo correspondente, como nos exemplos a seguir:

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

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

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

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

Os tipos e propriedades definidos como extensões do esquema do Google podem ser expandidos com http://schema.googleapis.com. Por exemplo,

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

A documentação de cada tipo e propriedade está disponível no URI correspondente.

Lista de extensões de esquema

As extensões de esquema usadas nesta API estão hospedadas em http://schema.googleapis.com como extensões externas.

A extensão type do Schema.org é:

• EntitySearchResult

As extensões de propriedade para o Schema.org são:

• detailedDescription
• resultScore