Método entity.search

Pesquisa no Mapa de informações as 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 a ser pesquisada 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 ...?ids=A&ids=B
languages	string	A lista de códigos de idioma (definidas no 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, entidades retornadas conterão um ou mais desses tipos.
indent	boolean	Ativa o recuo de resultados JSON.
prefix	boolean	Permite correspondência de prefixo (substring inicial) com nomes e aliases de entidades. Por exemplo, o prefixo "Jung" vai corresponder a entidades e aliases como 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, apresentadas em 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 do schema.org com suporte 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 do quanto a entidade correspondeu às restrições de solicitação.

Observação :os URLs das imagens são fornecidos para ajudar a confirmar a seleção de com a entidade correta. Assim como ocorre com todo o conteúdo obtido através das APIs do Google, você é é responsável por garantir que o uso das imagens esteja em conformidade com as lei.

Palavras-chave em JSON-LD

Para palavras-chave JSON-LD, como @context e @vocabulário @type ou @id, refere-se ao 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) que são compatíveis com o vocabulário do schema.org. Para mais detalhes sobre essas extensões, consulte Lista de extensões do esquema.

Para cada um dos tipos e propriedades (como Person) e propriedades do schema.org (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 expandido com http://schema.googleapis.com. Por exemplo:

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• detalheDescrição -> http://schema.googleapis.com/detailedDescription

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

Lista de extensões de esquema

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

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

• EntitySearchResult

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

• detailedDescription
• resultScore