Entidades de método

Busca en el Gráfico de conocimiento entidades que coincidan con las restricciones.

Solicitud HTTP

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

Parámetros de consulta

Nombre del parámetro	Tipo	Descripción
query	string	Una cadena literal para buscar en el Gráfico de conocimiento.
ids	string	Es una lista de los IDs de entidades que se buscarán en el Gráfico de conocimiento. Para especificar varios IDs en la solicitud HTTP, repite el parámetro en el URL como en ...?ids=A&ids=B
languages	string	La lista de códigos de idioma (definidos en la norma ISO 639) con los que se ejecutará la consulta, por ejemplo, "en".
types	string	Restringe las entidades mostradas a aquellas de los tipos especificados. Por ejemplo: puedes especificar "Person" (como se define en http://schema.org/Person) para restringir los resultados a entidades que representen a personas. Si se especifican varios tipos, las entidades mostradas contendrán uno o más de estos tipos.
indent	boolean	Habilita la sangría de resultados JSON.
prefix	boolean	Habilita la coincidencia de prefijos (subcadena inicial) con nombres y alias de entidades. Por ejemplo, el prefijo "Jung" coincidirá con entidades y alias como como `Jung`, `Jungle` y `Jung-ho Kang`.
limit	number	Limita la cantidad de entidades que se muestran. El máximo es 500. El valor predeterminado es 20. Las solicitudes con límites altos tienen más probabilidades de agotar el tiempo de espera.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Un mensaje de respuesta contiene una lista de entidades, presentada en JSON-LD y compatible con Esquemas de schema.org (con extensiones externas limitadas).

En el siguiente ejemplo de JSON-LD, se muestra cómo se estructura el cuerpo de la respuesta:

{
  "@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 respuesta

Nombre del campo	Tipo	Descripción
@id	string	El URI canónico de la entidad.
name	string	Es el nombre de la entidad.
@type	array	La lista de tipos de schema.org admitidos que coinciden con la entidad.
description	string	Una descripción breve de la entidad.
image	URL	Una imagen para ayudar a identificar la entidad.
detailedDescription	string	Es una descripción detallada de la entidad.
url	URL	Es la URL oficial del sitio web de la entidad, si está disponible.
resultScore	number	Un indicador de qué tan bien la entidad coincidió con las restricciones de la solicitud.

Nota: Las URLs de las imágenes se proporcionan para ayudarte a confirmar que seleccionaste la la entidad correcta. Como con todo el contenido que obtienes a través de las APIs de Google, estás responsable de garantizar que el uso que haga de las imágenes cumpla con las políticas .

Palabras clave de JSON-LD

En el caso de las palabras clave de JSON-LD, como @context , @vocab, @type o @id, consulta la Especificaciones de JSON-LD.

Compatibilidad con Schema.org

La respuesta usa el vocabulario alojado en schema.org, con extensiones limitadas (para ejemplo, resultScore) que son compatibles con el vocabulario de schema.org. Para obtener más información sobre estas extensiones, consulte Lista de extensiones de esquema.

Para cada uno de los tipos de Schema.org (como Person) y las propiedades (como name) hay un URI completo correspondiente, como en los siguientes ejemplos:

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

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

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

• descripción -> http://schema.org/description

Los tipos y las propiedades que se definen como extensiones de esquema de Google pueden ser expandido con http://schema.googleapis.com. Por ejemplo:

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

La documentación de cada tipo y propiedad está disponible en la el URI correspondiente.

Lista de extensiones de esquema

Las extensiones de esquema que se usan en esta API se alojan en http://schema.googleapis.com como extensiones externas.

La extensión type para Schema.org es la siguiente:

• EntitySearchResult

Las extensiones de propiedad de Schema.org son las siguientes:

• detailedDescription
• resultScore