Se usó la API de Cloud Translation para traducir esta página.

Ejecuta muestras de código

El Explorador de API de Google genera muestras de código de forma dinámica. Estas muestras de código están diseñadas para copiarse y ejecutarse de forma local. Para ver las muestras, haz clic en Pantalla completa en el panel lateral del Explorador de API. En la siguiente figura, se muestra el Explorador de API expandido en pantalla completa:

**Figura 2**: Panel de pantalla completa del Explorador de API para la API de Google Libros.

De forma predeterminada, el Explorador de API muestra cómo usar cURL para ejecutar tu solicitud. Algunas API también pueden mostrar muestras para otros lenguajes, como JavaScript, Java y Python.

Ejecuta muestras de código de manera local

En las siguientes pestañas, se explican los requisitos previos y los pasos para ejecutar muestras de código. Para ejecutar las muestras de código, debes generar y usar tus propias credenciales de autorización. Para obtener una explicación de cómo crear un proyecto y generar credenciales, consulta la documentación específica de la API de Google.

Las credenciales son uno de los siguientes, según el tipo de datos (públicos o privados) a los que accede el método:

Para los datos públicos, la credencial es una clave de API.
Para los datos privados, la credencial es un archivo client_secret.json que contiene el ID y el secreto de cliente de OAuth 2.0 o un token de acceso de OAuth 2.0.

cURL

Configuración

Sigue las instrucciones en la documentación de la API a fin de crear o seleccionar un proyecto para tu app y habilitar la API.
En Cloud Console, crea una clave de API.
En Cloud Console, crea una credencial de ID de cliente de OAuth para una aplicación web y usa https://developers.google.com/oauthplayground como el URI de redireccionamiento.
En OAuth 2.0 Playground, haz clic en Configuración de OAuth 2.0 .
Marca Usa tus propias credenciales.
Ingresa el ID de cliente y el secreto de cliente generados en el paso 3.
En el campo de alcances, escribe el alcance que deseas utilizar con tu método y haz clic en Autorizar API.
(Opcional) Si aparece una pantalla de acceso, selecciona la cuenta que deseas usar.
(Opcional) Si aparece una pantalla de autorización, haga clic en Aceptar.
Haga clic en Intercambiar código de autorización para tokens. Se muestra un token.
En la muestra de código cURL, reemplaza [YOUR_API_KEY] por la clave de API generada en el paso 2: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \.
En la muestra de código cURL, reemplaza [YOUR_ACCESS_TOKEN] por el token de acceso generado en el paso 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \.

Cómo ejecutar una muestra de código

Desde la línea de comandos, ejecuta el comando cURL. El comando debería ser similar al siguiente:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

Configuración

Sigue las instrucciones en la documentación de la API a fin de crear o seleccionar un proyecto para tu app y habilitar la API.
En Cloud Console, crea una clave de API.
En Cloud Console, crea una credencial de ID de cliente de OAuth para una “aplicación web” y configura los orígenes autorizados de JavaScript a fin de identificar la URL desde la que enviarás solicitudes, como http://localhost.
Copia la muestra de código completa en un archivo local al que pueda acceder tu servidor web, como /var/www/html/example.html.
Busca la línea en la muestra de código que establece la clave de API o el ID de cliente y reemplaza el valor por los valores generados en los pasos 2 y 3:
- Clave de API: gapi.client.setApiKey(YOUR_API_KEY);
- ID de cliente de OAuth 2.0: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Cómo ejecutar una muestra de código

Abre el archivo en tu navegador, como http://localhost/example.html. Te recomendamos usar un navegador con una consola de depuración, como Google Chrome.
(Opcional) Si aparece una pantalla de acceso, selecciona la cuenta que deseas usar.
(Opcional) Si aparece una pantalla de autorización, haga clic en Aceptar. La consola de depuración debe mostrar la respuesta del método como un objeto JSON.

Java

Requisitos previos

Java 1.7 o superior
Gradle 7 o una versión posterior

Configuración

Sigue las instrucciones en la documentación de la API a fin de crear o seleccionar un proyecto para tu app y habilitar la API.
Según el tipo de datos al que acceda el método, crea una clave de API (datos públicos) o un ID de cliente de OAuth 2.0 (datos privados).
Configure el tipo de aplicación como Aplicación de escritorio.
Si creaste un ID de cliente de OAuth 2.0, descarga el archivo JSON que contiene tus credenciales de OAuth 2.0. Este archivo tiene un nombre similar a client_secret_CLIENTID.json, en el que CLIENTID es el ID de cliente de tu proyecto.
En el directorio de trabajo, ejecuta los siguientes comandos para crear una estructura de proyecto nueva:
```
$ gradle init --type basic
$ mkdir -p src/main/java src/main/resources
```
Si creaste un ID de cliente de OAuth 2.0 en el paso 2, cambia el nombre del archivo JSON que descargaste a client_secret.json.
Guarda el archivo al que le cambiaste el nombre en el directorio src/main/resources que creaste en el paso 5.

En tu directorio de trabajo, abre el archivo build.gradle y reemplaza su contenido por lo siguiente:

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

En el archivo build.gradle, reemplaza la línea que dice API_SPECIFIC_DEPENDENCY con una instrucción de compilación de código para la API a la que estás llamando. Este es un ejemplo para la API de YouTube Analytics:
```
compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'
```
La instrucción sigue esta plantilla:
```
compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'
```

Aquí:

API_NAME es el nombre de la API que aparece en GitHub para la API. Para encontrar el nombre, haz clic en el vínculo de la versión junto a tu API en la página API de Google compatibles. El vínculo de la versión navega a GitHub. El nombre de la API está en la mitad superior de la página y está precedido por googleapis/google-apis-services-. Por ejemplo, para la v3 de la API de Drive, el API_NAME es drive.
API_VERSION es la versión de la API que aparece para la API debajo del nombre de la API en la página de las API de Google compatibles.
REVISION es el número de revisión que aparece en la referencia de JavaDoc para la API. La referencia de JavaDoc se puede encontrar en https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html.
CL_VERSION es la versión de la biblioteca cliente. Este valor también aparece en la referencia de JavaDoc.
Desde tu directorio de trabajo, copia la muestra de código del Explorador de API en src/main/java/ApiExample.java. (El nombre de clase en cada muestra es ApiExample, por lo que no necesitas modificar el archivo build.gradle para ejecutar muestras diferentes.

Cómo ejecutar una muestra de código

Usa el siguiente comando para ejecutar el ejemplo:

  gradle -q run

La muestra debe ejecutar tu solicitud a la API y debe imprimir la respuesta en STDOUT. También puedes verificar el servicio al que estás llamando para ver los efectos de las solicitudes que escriben datos.

Node.js

Requisitos previos

Node.js
La biblioteca cliente de las API de Google para Node.js:
- Si no instalaste la biblioteca cliente con anterioridad, ejecuta el siguiente comando:
```
npm install googleapis --save
```
- Si ya instalaste la biblioteca cliente, te recomendamos que la actualices para asegurarte de tener las clases más actualizadas de la biblioteca que estás probando. Para actualizar la biblioteca cliente, ejecuta el siguiente comando:
```
npm update googleapis --save
```

Configuración

Sigue las instrucciones en la documentación de la API a fin de crear o seleccionar un proyecto para tu app y habilitar la API.
Según el tipo de datos al que acceda el método, crea una clave de API (datos públicos) o un ID de cliente de OAuth 2.0 (datos privados).
Configure el tipo de aplicación como Aplicación de escritorio.
Si creaste un ID de cliente de OAuth 2.0, descarga el archivo JSON que contiene tus credenciales de OAuth 2.0. Este archivo tiene un nombre similar a client_secret_CLIENTID.json, en el que CLIENTID es el ID de cliente de tu proyecto.
Copia la muestra de código en un archivo local y modifícala para identificar de manera correcta tu clave de API o el archivo de secretos del cliente. En la muestra, el valor de la clave de API es YOUR_API_KEY y la ubicación del archivo de secretos del cliente es YOUR_CLIENT_SECRET_FILE.json.

Cómo ejecutar una muestra de código

Usa el siguiente comando para ejecutar el ejemplo:

  node sample.js

La mayoría de los ejemplos imprimen una respuesta de API (o algo más) en STDOUT.

PHP

Requisitos previos

PHP 5.4 o superior con la interfaz de línea de comandos (CLI) y la extensión JSON
La herramienta de administración de dependencias de Composer instalada de forma global
La biblioteca cliente de las API de Google para PHP:
- Si no instalaste la biblioteca cliente con anterioridad, ejecuta el siguiente comando:
```
composer require google/apiclient:^2.0
```
- Si ya instalaste la biblioteca cliente, te recomendamos que la actualices a fin de asegurarte de tener las clases más actualizadas para la biblioteca que estás probando. Para actualizar la biblioteca cliente, ejecuta el siguiente comando:
```
composer update google/apiclient --with-dependencies
```

Cómo ejecutar una muestra de código

Usa el siguiente comando para ejecutar el ejemplo:

  php sample.php

La mayoría de los ejemplos imprimen una respuesta de API (o algo más) en STDOUT.

Python

Requisitos previos

Python 2.7 o Python 3.5+
La herramienta de administración de paquetes pip
La biblioteca cliente de las API de Google para Python:
```
pip install --upgrade google-api-python-client
```
Las bibliotecas google-auth-oauthlib y google-auth-httplib2 para la autorización del usuario:
```
pip install --upgrade google-auth-oauthlib google-auth-httplib2
```

Configuración

Sigue las instrucciones en la documentación de la API a fin de crear o seleccionar un proyecto para tu app y habilitar la API.
Según el tipo de datos al que acceda el método, crea una clave de API (datos públicos) o un ID de cliente de OAuth 2.0 (datos privados).
Configure el tipo de aplicación como Aplicación de escritorio.
Si creaste un ID de cliente de OAuth 2.0, descarga el archivo JSON que contiene tus credenciales de OAuth 2.0. Este archivo tiene un nombre similar a client_secret_CLIENTID.json, en el que CLIENTID es el ID de cliente de tu proyecto.
Copia la muestra de código en un archivo local y modifícala para identificar de manera correcta tu clave de API o el archivo de secretos del cliente. En la muestra, el valor de la clave de API es YOUR_API_KEY y la ubicación del archivo de secretos del cliente es YOUR_CLIENT_SECRET_FILE.json.

Cómo ejecutar una muestra de código

Usa el siguiente comando para ejecutar el ejemplo:

  python sample.py

La mayoría de los ejemplos imprimen una respuesta de API (o algo más) en STDOUT.

Ruby

Requisitos previos

Ruby 2.0 o superior
La biblioteca cliente de las API de Google para Ruby:
```
gem install google-api-client`
```

Configuración

Sigue las instrucciones en la documentación de la API a fin de crear o seleccionar un proyecto para tu app y habilitar la API.
Según el tipo de datos al que acceda el método, crea una clave de API (datos públicos) o un ID de cliente de OAuth 2.0 (datos privados).
Configure el tipo de aplicación como Aplicación de escritorio.
Si creaste un ID de cliente de OAuth 2.0, descarga el archivo JSON que contiene tus credenciales de OAuth 2.0. Este archivo tiene un nombre similar a client_secret_CLIENTID.json, en el que CLIENTID es el ID de cliente de tu proyecto.
Copia la muestra de código en un archivo local y modifícala para identificar de manera correcta tu clave de API o el archivo de secretos del cliente. En la muestra, el valor de la clave de API es YOUR_API_KEY y la ubicación del archivo de secretos del cliente es YOUR_CLIENT_SECRET_FILE.json.

Cómo ejecutar una muestra de código

Usa el siguiente comando para ejecutar el ejemplo:

  ruby sample.rb

La mayoría de los ejemplos imprimen una respuesta de API (o algo más) en STDOUT.

Cómo solucionar problemas de muestra

No aparece el cuadro de diálogo de autorización

El Explorador de API utiliza una ventana emergente para otorgar acceso a tus datos privados. Si tu navegador bloquea las ventanas emergentes, esta no aparecerá y no podrás otorgar acceso.

Si haces clic en “Permitir” en la pantalla de autorización y no sucede nada, intenta cambiar la configuración de la ventana emergente de tu navegador para habilitar las ventanas emergentes.

Recibiste un error 401 o 403

Si recibes un error 401 o 403 cuando pruebas una muestra, es probable que se deba a un problema con una de las siguientes opciones:

La API no está habilitada para tu proyecto. Revisa las instrucciones para tu API sobre cómo crear un proyecto y habilitar una API.
Utilizas un tipo de autorización incorrecto (clave de API en lugar de OAuth 2.0).
Usas OAuth 2.0, pero con un alcance demasiado reducido.
Cuando configuras tu clave de API, estableces restricciones para evitar el uso no autorizado de tus credenciales. Sin embargo, la solicitud no cumple con esas restricciones. Para obtener más información, consulta Usa restricciones de clave de API.

Recibiste una advertencia sobre contenido mixto

Si usas Google Cloud Endpoints y ejecutas tu extremo en un servidor de desarrollo, tu navegador puede mostrar una advertencia sobre el contenido mixto. Esta advertencia se produce porque el Explorador de API se carga en HTTPS, pero cuando tu API se ejecuta de forma local, se aloja en HTTP.

Para ocultar esta advertencia con Chrome, inicia una sesión de Chrome con marcas especiales de la siguiente manera:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

Por ejemplo:

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

Solo debes ocultar esta advertencia para realizar pruebas locales.

Solo JavaScript: gapi no está definido

Un "gapi no está definido" se produce cuando el código JavaScript intenta llamar a la biblioteca cliente de la API de Google para JavaScript antes de que la biblioteca se haya cargado. Asegúrate de que el código que hace referencia a la variable gapi no se llame hasta que se haya cargado la biblioteca cliente.