Método entities.search

Pesquisa o Mapa de informações por entidades que correspondam à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 entidade 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 em ISO 639) para executar a consulta, por exemplo, "en".
types	string	Restringe as entidades retornadas àquelas dos tipos especificados. Por exemplo, especifique "Person" (conforme definido em http://schema.org/Person) para restringir os resultados a entidades que representem pessoas. Se vários tipos forem especificados, as entidades retornadas terão um ou mais desses tipos.
indent	boolean	Ativa o recuo dos resultados JSON.
prefix	boolean	Permite a correspondência de prefixo (substring inicial) com nomes e aliases de entidades. Por exemplo, um prefixo "Jung" 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 chance de expirar.

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 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 para a entidade.
name	string	É o nome da entidade.
@type	array	A lista de tipos schema.org compatíveis 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 oficial do site da entidade, se disponível.
resultScore	number	Um indicador da eficiência da entidade em relação às restrições da solicitação.

Observação: URLs de imagem são fornecidos para ajudar a confirmar se você selecionou a entidade correta. Assim como todo o conteúdo recebido 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 o schema.org

A resposta usa o vocabulário hospedado no schema.org, com extensões limitadas (por exemplo, resultScore) que são 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 Schema.org (como Person) e propriedades (como name), há um URI completo correspondente, como nos exemplos a seguir:

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

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

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

• descrição -> http://schema.org/description

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

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

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 são hospedadas em http://schema.googleapis.com como extensões externas.

A extensão type para o Schema.org é a seguinte:

• EntitySearchResult

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

• descrição detalhada
• resultScore