API Developer Knowledge

La API Developer Knowledge proporciona acceso programático a la documentación pública para desarrolladores de Google, lo que te permite integrar esta base de conocimientos en tus propias aplicaciones y flujos de trabajo.

Información general

La API Developer Knowledge se ha diseñado para ser la fuente canónica de acceso legible por máquina a la documentación para desarrolladores de Google. Ofrece dos funciones principales:

  • SearchDocumentChunks para encontrar URIs de páginas y fragmentos de contenido relevantes en función de una consulta.
  • GetDocument o BatchGetDocuments para obtener todo el contenido de los resultados de búsqueda.

Para empezar rápidamente, sigue la guía de inicio rápido.

El corpus de contenido disponible para búsquedas se indica en la referencia de corpus.

Nota sobre la vista previa: Esta versión preliminar permite buscar y recuperar páginas de documentación como contenido de Markdown no estructurado.

Habilitar la API

Para usar la API Developer Knowledge, primero debes habilitarla en tu proyecto en la nube de Google.

  1. Abre la página de la API Developer Knowledge en la biblioteca de APIs de Google.
  2. Comprueba que hayas seleccionado el proyecto correcto en el que quieres usar la API.
  3. Haz clic en Habilitar. No se necesitan roles de gestión de identidades y accesos específicos para habilitar o usar la API.

Autenticación

Para usar la API Developer Knowledge, se necesita una clave de API Developer Knowledge. Para crear uno, sigue estos pasos:

  1. En la consola de Google Cloud del proyecto en el que has habilitado la API, ve a la página Credenciales.
  2. Haz clic en Crear credenciales y, a continuación, selecciona Clave de API en el menú. En el cuadro de diálogo de la clave de API creada, se muestra la cadena de la clave que acabas de crear.
  3. Haz clic en Editar clave de API.
  4. En el campo Nombre, asigna un nombre a la clave.
  5. En Restricciones de API, selecciona Restringir clave.
  6. En la lista Seleccionar APIs, habilita API Developer Knowledge y haz clic en Aceptar.
    • Nota: Si acabas de habilitar la API Developer Knowledge, puede que tarde un poco en aparecer en la lista Seleccionar APIs.
  7. Haz clic en Guardar.

Incluye esta clave de API Developer Knowledge en tus solicitudes. Por ejemplo, las llamadas REST deben incluirlo mediante el parámetro de consulta key. Consulta un ejemplo en la guía de inicio rápido.

Documentación incluida

Consulta la referencia de corpus para obtener información sobre los documentos en los que busca la API.

Limitaciones conocidas

  • Calidad de Markdown: el Markdown se genera a partir del HTML de origen. Puede que haya algunas discrepancias o problemas de formato.
  • Ámbito del contenido: solo se incluyen las páginas públicas de la referencia de corpus. No se incluye contenido de otras fuentes, como GitHub, sitios de software de código abierto, blogs o YouTube.