OAuth 2.0 para aplicaciones de TV y dispositivos de entrada limitada

En este documento, se explica cómo implementar la autorización OAuth 2.0 para acceder a la API de YouTube Data a través de aplicaciones que se ejecutan en dispositivos como TVs, impresoras y consolas de juegos. Más específicamente, este flujo está diseñado para dispositivos que no tienen acceso a un navegador o tienen capacidades de entrada limitadas.

OAuth 2.0 permite a los usuarios compartir datos específicos con una aplicación al mismo tiempo que mantiene la privacidad de sus nombres de usuario, contraseñas y otra información. Por ejemplo, una aplicación de TV podría usar OAuth 2.0 para obtener permiso y, así, seleccionar un archivo almacenado en Google Drive.

Dado que las aplicaciones que usan este flujo se distribuyen a dispositivos individuales, se asume que no pueden guardar secretos. Pueden acceder a las APIs de Google mientras el usuario está presente en la app o cuando esta se ejecuta en segundo plano.

Alternativas

Si desarrollas una app para una plataforma como Android, iOS, macOS, Linux o Windows (incluida la Plataforma Universal de Windows), que tiene acceso al navegador y capacidades de entrada completas, usa el flujo de OAuth 2.0 en aplicaciones para dispositivos móviles y computadoras. (Debes usar ese flujo incluso si tu app es una herramienta de línea de comandos sin interfaz gráfica).

Si solo deseas que los usuarios accedan con sus Cuentas de Google y usar el token de ID JWT para obtener información básica del perfil del usuario, consulta Acceso en TVs y dispositivos de entrada limitados.

Requisitos previos

Habilita las API para tu proyecto.

Cualquier aplicación que llame a las APIs de Google debe habilitarlas en la API Console.

Sigue estos pasos para habilitar una API en tu proyecto:

  1. Open the API Library en Google API Console.
  2. If prompted, select a project, or create a new one.
  3. Usa la página Biblioteca para encontrar y habilitar la API de datos de YouTube. Busca otras APIs que usará tu aplicación y habilítalas también.

Crea credenciales de autorización

Cualquier aplicación que use OAuth 2.0 para acceder a las APIs de Google debe tener credenciales de autorización que identifiquen la aplicación para el servidor de OAuth 2.0 de Google. En los siguientes pasos, se explica cómo crear credenciales para tu proyecto. Luego, las aplicaciones pueden usar las credenciales para acceder a las APIs que habilitaste para ese proyecto.

  1. Go to the Credentials page.
  2. Haz clic en Crear credenciales > ID de cliente de OAuth.
  3. Selecciona el tipo de app TVs y dispositivos de entrada limitados.
  4. Asigna un nombre a tu cliente de OAuth 2.0 y haz clic en Crear.

Identifica los permisos de acceso

Los permisos permiten que tu aplicación solo solicite acceso a los recursos que necesita y, al mismo tiempo, permiten a los usuarios controlar la cantidad de acceso que otorgan a tu aplicación. Por lo tanto, puede haber una relación inversa entre la cantidad de permisos solicitados y la probabilidad de obtener el consentimiento del usuario.

Antes de que comiences a implementar la autorización de OAuth 2.0, te recomendamos identificar los permisos a los que tu app necesitará permiso para acceder.

La versión 3 de la API de YouTube Data utiliza los siguientes alcances:

Permisos
https://www.googleapis.com/auth/youtubeAdministrar tu cuenta de YouTube
https://www.googleapis.com/auth/youtube.channel-memberships.creatorVer una lista de los miembros actuales y activos de su canal, su nivel actual y el momento en que se hicieron miembros
https://www.googleapis.com/auth/youtube.force-sslVea, edite y borre de forma permanente sus videos, calificaciones, comentarios y subtítulos de YouTube
https://www.googleapis.com/auth/youtube.readonlyPermite ver tu cuenta de YouTube.
https://www.googleapis.com/auth/youtube.uploadPermite administrar tus videos de YouTube.
https://www.googleapis.com/auth/youtubepartnerVer y administrar sus elementos y el contenido asociado en YouTube
https://www.googleapis.com/auth/youtubepartner-channel-auditPermite ver información privada de tu canal de YouTube que sea relevante durante el proceso de auditoría con un socio de YouTube.

Consulta la lista Permisos permitidos para las apps o los dispositivos instalados.

Obtén tokens de acceso de OAuth 2.0

Si bien tu aplicación se ejecuta en un dispositivo con capacidades de entrada limitadas, los usuarios deben tener acceso independiente a un dispositivo con capacidades de entrada más completas para completar este flujo de autorización. El flujo tiene los siguientes pasos:

  1. La aplicación envía una solicitud al servidor de autorización de Google que identifica los permisos a los que solicitará permiso.
  2. El servidor responde con varios datos que se usan en pasos posteriores, como un código de dispositivo y de usuario.
  3. Debes mostrar información que el usuario puede ingresar en otro dispositivo para autorizar tu app.
  4. La aplicación comienza a sondear el servidor de autorización de Google para determinar si el usuario autorizó tu app.
  5. El usuario cambia a un dispositivo con funciones de entrada más completas, inicia un navegador web, navega a la URL que se muestra en el paso 3 e ingresa un código que también aparecerá en el paso 3. Luego, el usuario puede otorgar (o denegar) el acceso a tu aplicación.
  6. La siguiente respuesta a tu solicitud de sondeo contiene los tokens que tu app necesita para autorizar solicitudes en nombre del usuario. (Si el usuario rechazó el acceso a la aplicación, la respuesta no contiene tokens).

En la siguiente imagen, se ilustra este proceso:

El usuario accede en otro dispositivo que tiene un navegador.

En las siguientes secciones, se explican estos pasos en detalle. Dada la variedad de funciones y entornos de ejecución que pueden tener los dispositivos, en los ejemplos de este documento se usa la utilidad de línea de comandos curl. Estos ejemplos deben ser fáciles de transferir a varios lenguajes y entornos de ejecución.

Paso 1: Solicita los códigos de dispositivo y usuario

En este paso, el dispositivo envía una solicitud HTTP POST al servidor de autorización de Google, en https://oauth2.googleapis.com/device/code, que identifica la aplicación y los permisos de acceso a los que quiere acceder en nombre del usuario. Debes recuperar esta URL del documento de descubrimiento con el valor de metadatos device_authorization_endpoint. Incluye los siguientes parámetros de solicitud HTTP:

Parámetros
client_id Obligatorio

El ID de cliente de tu aplicación. Puedes encontrar este valor en API Console Credentials page.

scope Obligatorio

Una lista de permisos delimitados por espacios que identifican los recursos a los que tu aplicación podría acceder en nombre del usuario. Estos valores informan la pantalla de consentimiento que Google muestra al usuario. Consulta la lista de Permisos permitidos para las apps o los dispositivos instalados.

Los permisos permiten que tu aplicación solo solicite acceso a los recursos que necesita y, a su vez, permiten que los usuarios controlen la cantidad de acceso que otorgan a tu aplicación. Por lo tanto, existe una relación inversa entre la cantidad de permisos solicitados y la probabilidad de obtener el consentimiento del usuario.

La versión 3 de la API de YouTube Data utiliza los siguientes alcances:

Permisos
https://www.googleapis.com/auth/youtubeAdministrar tu cuenta de YouTube
https://www.googleapis.com/auth/youtube.channel-memberships.creatorVer una lista de los miembros actuales y activos de su canal, su nivel actual y el momento en que se hicieron miembros
https://www.googleapis.com/auth/youtube.force-sslVea, edite y borre de forma permanente sus videos, calificaciones, comentarios y subtítulos de YouTube
https://www.googleapis.com/auth/youtube.readonlyPermite ver tu cuenta de YouTube.
https://www.googleapis.com/auth/youtube.uploadPermite administrar tus videos de YouTube.
https://www.googleapis.com/auth/youtubepartnerVer y administrar sus elementos y el contenido asociado en YouTube
https://www.googleapis.com/auth/youtubepartner-channel-auditPermite ver información privada de tu canal de YouTube que sea relevante durante el proceso de auditoría con un socio de YouTube.

En el documento Permisos de la API de OAuth 2.0, se proporciona una lista completa de los permisos que puedes usar para acceder a las API de Google.

Ejemplos

En el siguiente fragmento, se muestra una solicitud de muestra:

POST /device/code HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyoutube.readonly

En este ejemplo, se muestra un comando curl para enviar la misma solicitud:

curl -d "client_id=client_id&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fyoutube.readonly" \
     https://oauth2.googleapis.com/device/code

Paso 2: Controla la respuesta del servidor de autorización

El servidor de autorización mostrará una de las siguientes respuestas:

Respuesta exitosa

Si la solicitud es válida, tu respuesta será un objeto JSON que contiene las siguientes propiedades:

Propiedades
device_code Es un valor que Google asigna de manera única para identificar el dispositivo que ejecuta la app que solicita autorización. El usuario autorizará ese dispositivo desde otro dispositivo con capacidades de entrada más completas. Por ejemplo, un usuario puede utilizar una laptop o un teléfono celular para autorizar una app que se ejecute en una TV. En este caso, device_code identifica la TV.

Este código permite que el dispositivo que ejecuta la app determine de forma segura si el usuario otorgó o rechazó el acceso.

expires_in Es el tiempo, en segundos, en que son válidos los objetos device_code y user_code. Si en ese tiempo el usuario no completa el flujo de autorización y tu dispositivo tampoco realiza un sondeo para recuperar información sobre la decisión del usuario, es posible que debas reiniciar este proceso desde el paso 1.
interval Es el tiempo, en segundos, que el dispositivo debe esperar entre solicitudes de sondeo. Por ejemplo, si el valor es 5, tu dispositivo debe enviar una solicitud de sondeo al servidor de autorización de Google cada cinco segundos. Consulta el paso 3 para obtener más detalles.
user_code Es un valor que distingue mayúsculas de minúsculas y que identifica los permisos a los que la aplicación solicita acceso. Tu interfaz de usuario le indicará al usuario que ingrese este valor en otro dispositivo con funciones de entrada más completas. Luego, Google usa el valor para mostrar el conjunto correcto de permisos cuando le solicita al usuario que otorgue acceso a tu aplicación.
verification_url Una URL a la que el usuario debe navegar, en otro dispositivo, para ingresar a user_code y otorgar o denegar el acceso a tu aplicación. También se mostrará este valor en la interfaz de usuario.

En el siguiente fragmento, se muestra una respuesta de muestra:

{
  "device_code": "4/4-GMMhmHCXhWEzkobqIHGG_EnNYYsAkukHspeYUk9E8",
  "user_code": "GQVQ-JKEC",
  "verification_url": "https://www.google.com/device",
  "expires_in": 1800,
  "interval": 5
}

Respuesta de cuota excedida

Si las solicitudes de código de tu dispositivo superaron la cuota asociada con tu ID de cliente, recibirás una respuesta 403 con el siguiente error:

{
  "error_code": "rate_limit_exceeded"
}

En ese caso, usa una estrategia de retirada para reducir la tasa de solicitudes.

Paso 3: Muestra el código de usuario

Muestra al usuario los valores de verification_url y user_code obtenidos en el paso 2. Ambos valores pueden contener cualquier carácter imprimible del grupo de caracteres US-ASCII. El contenido que le muestras al usuario debe indicarle que navegue a verification_url en otro dispositivo y que ingrese el user_code.

Ten en cuenta las siguientes reglas para diseñar la interfaz de usuario (IU):

  • user_code
    • Se debe mostrar el user_code en un campo que admita 15 caracteres de tamaño “W”. En otras palabras, si puedes mostrar el código WWWWWWWWWWWWWWW de forma correcta, la IU será válida, y te recomendamos que uses ese valor de cadena cuando pruebes la forma en que se muestra user_code en la IU.
    • El user_code distingue entre mayúsculas y minúsculas, y no se debe modificar de ninguna manera, como al cambiar las mayúsculas y minúsculas o insertar otros caracteres de formato.
  • verification_url
    • El espacio en el que muestras el verification_url debe ser lo suficientemente ancho como para admitir una string de URL de 40 caracteres.
    • No debes modificar verification_url de ninguna manera, excepto para quitar, de manera opcional, el esquema que se mostrará. Si planeas quitar el esquema (p.ej., https://) de la URL por motivos de visualización, asegúrate de que tu app pueda controlar las variantes http y https.

Paso 4: Sondea el servidor de autorización de Google

Como el usuario usará otro dispositivo para navegar a verification_url y otorgar (o rechazar) acceso, el dispositivo solicitante no recibe una notificación automática cuando el usuario responde a la solicitud de acceso. Por ese motivo, el dispositivo solicitante debe consultar el servidor de autorización de Google para determinar cuándo el usuario respondió a la solicitud.

El dispositivo solicitante debe seguir enviando solicitudes de sondeo hasta que reciba una respuesta que indique que el usuario respondió a la solicitud de acceso o hasta que hayan vencido device_code y user_code obtenidos en el paso 2. El interval que se mostró en el paso 2 especifica la cantidad de tiempo, en segundos, que debe esperarse entre las solicitudes.

La URL del extremo que se sondeará es https://oauth2.googleapis.com/token. La solicitud de sondeo contiene los siguientes parámetros:

Parámetros
client_id El ID de cliente de tu aplicación. Puedes encontrar este valor en API Console Credentials page.
client_secret El secreto del cliente para el client_id proporcionado. Puedes encontrar este valor en API Console Credentials page.
device_code La device_code que muestra el servidor de autorización en el paso 2
grant_type Configura este valor en urn:ietf:params:oauth:grant-type:device_code.

Ejemplos

En el siguiente fragmento, se muestra una solicitud de muestra:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&
client_secret=client_secret&
device_code=device_code&
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code

En este ejemplo, se muestra un comando curl para enviar la misma solicitud:

curl -d "client_id=client_id&client_secret=client_secret& \
         device_code=device_code& \
         grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code" \
         -H "Content-Type: application/x-www-form-urlencoded" \
         https://oauth2.googleapis.com/token

Paso 5: El usuario responde la solicitud de acceso

En la siguiente imagen, se muestra una página similar a la que ven los usuarios cuando navegan al verification_url que mostraste en el paso 3:

Ingresa un código para conectar un dispositivo

Después de ingresar el user_code y, si aún no accedió a Google, el usuario ve una pantalla de consentimiento como la que aparece a continuación:

Ejemplo de pantalla de consentimiento para un cliente de dispositivo

Paso 6: Controla las respuestas a las solicitudes de sondeo

El servidor de autorización de Google responde a cada solicitud de sondeo con una de las siguientes respuestas:

Se permite el acceso

Si el usuario otorgó acceso al dispositivo (haciendo clic en Allow en la pantalla de consentimiento), la respuesta contendrá un token de acceso y un token de actualización. Los tokens permiten que tu dispositivo acceda a las APIs de Google en nombre del usuario. (La propiedad scope de la respuesta determina las APIs a las que puede acceder el dispositivo).

En este caso, la respuesta de la API contiene los siguientes campos:

Campos
access_token El token que envía la aplicación para autorizar una solicitud a la API de Google.
expires_in La vida útil restante del token de acceso, expresada en segundos.
refresh_token Un token que puedes usar para obtener un token de acceso nuevo. Los tokens de actualización son válidos hasta que el usuario revoque el acceso. Ten en cuenta que los tokens de actualización siempre se muestran para los dispositivos.
scope Los permisos de acceso que otorga access_token, expresados como una lista de strings delimitadas por espacios y que distinguen mayúsculas de minúsculas.
token_type El tipo de token que se muestra. En este momento, el valor de este campo siempre es Bearer.

En el siguiente fragmento, se muestra una respuesta de muestra:

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
  "token_type": "Bearer",
  "refresh_token": "1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

Los tokens de acceso tienen una vida útil limitada. Si tu aplicación necesita acceder a una API durante un período prolongado, puede usar el token de actualización para obtener un token de acceso nuevo. Si tu aplicación necesita este tipo de acceso, debe almacenar el token de actualización para usarlo más adelante.

Acceso denegado

Si el usuario se niega a otorgar acceso al dispositivo, la respuesta del servidor tendrá un código de estado de respuesta HTTP 403 (Forbidden). La respuesta contendrá el siguiente error:

{
  "error": "access_denied",
  "error_description": "Forbidden"
}

Autorización pendiente

Si el usuario aún no completó el flujo de autorización, el servidor muestra un código de estado de respuesta HTTP 428 (Precondition Required). La respuesta contiene el siguiente error:

{
  "error": "authorization_pending",
  "error_description": "Precondition Required"
}

Encuestas con demasiada frecuencia

Si el dispositivo envía solicitudes de sondeo con demasiada frecuencia, el servidor muestra un código de estado de respuesta HTTP (Forbidden) 403. La respuesta contiene el siguiente error:

{
  "error": "slow_down",
  "error_description": "Forbidden"
}

Otros errores

El servidor de autorización también muestra errores si a la solicitud de sondeo le faltan parámetros obligatorios o si tiene un valor de parámetro incorrecto. Estas solicitudes suelen tener un código de estado de respuesta HTTP 400 (Bad Request) o 401 (Unauthorized). Entre esos errores, se incluyen los siguientes:

Error Código de estado HTTP Descripción
admin_policy_enforced 400 La Cuenta de Google no puede autorizar uno o más permisos solicitados debido a las políticas del administrador de Google Workspace. Consulta el artículo de ayuda para administradores de Google Workspace Controla qué apps internas y de terceros acceden a los datos de Google Workspace para obtener más información sobre cómo un administrador puede restringir el acceso a los permisos hasta que se otorgue acceso de manera explícita a tu ID de cliente de OAuth.
invalid_client 401

No se encontró el cliente de OAuth. Por ejemplo, este error se produce si el valor del parámetro client_id no es válido.

El tipo de cliente de OAuth es incorrecto. Asegúrate de que el tipo de aplicación para el ID de cliente esté configurado en TVs y dispositivos de entrada limitados.

invalid_grant 400 El valor del parámetro code no es válido, ya se reclamó o no se puede analizar.
unsupported_grant_type 400 El valor del parámetro grant_type no es válido.
org_internal 403 El ID de cliente de OAuth en la solicitud es parte de un proyecto que limita el acceso a las Cuentas de Google en una organización de Google Cloud específica. Confirma la configuración del tipo de usuario de tu aplicación de OAuth.

Llama a las APIs de Google

Una vez que tu aplicación obtiene un token de acceso, puedes usarlo para realizar llamadas a una API de Google en nombre de una cuenta de usuario determinada si se otorgaron los permisos de acceso que requiere la API. Para ello, incluye el token de acceso en una solicitud a la API. Para ello, incluye un parámetro de consulta access_token o un valor Bearer del encabezado HTTP Authorization. Cuando es posible, se prefiere el encabezado HTTP, ya que las cadenas de consulta tienden a ser visibles en los registros del servidor. En la mayoría de los casos, puedes usar una biblioteca cliente para configurar tus llamadas a las APIs de Google (por ejemplo, cuando llamas a la API de datos de YouTube).

Ten en cuenta que la API de datos de YouTube solo admite cuentas de servicio para los propietarios del contenido de YouTube que poseen y administran varios canales de YouTube, como sellos discográficos y estudios cinematográficos.

Puedes probar todas las API de Google y ver sus alcances en OAuth 2.0 Playground.

Ejemplos de GET HTTP

Una llamada al extremo youtube.channels (la API de YouTube Data) con el encabezado HTTP Authorization: Bearer podría verse de la siguiente manera: Ten en cuenta que debes especificar tu propio token de acceso:

GET /youtube/v3/channels?part=snippet&mine=true HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

Esta es una llamada a la misma API para el usuario autenticado que usa el parámetro de cadena de consulta access_token:

GET https://www.googleapis.com/youtube/v3/channels?access_token=access_token&part=snippet&mine=true

curl ejemplos

Puedes probar estos comandos con la aplicación de línea de comandos curl. A continuación, se muestra un ejemplo en el que se usa la opción de encabezado HTTP (opción preferida):

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/youtube/v3/channels?part=snippet&mine=true

Como alternativa, puedes usar la opción del parámetro de cadena de consulta:

curl https://www.googleapis.com/youtube/v3/channels?access_token=access_token&part=snippet&mine=true

Actualización de un token de acceso

Los tokens de acceso caducan periódicamente y se convierten en credenciales no válidas para una solicitud a la API relacionada. Puedes actualizar un token de acceso sin solicitarle permiso al usuario (incluso cuando no está presente) si solicitaste acceso sin conexión a los permisos asociados con el token.

Para actualizar un token de acceso, la aplicación envía una solicitud POST HTTPS al servidor de autorización de Google (https://oauth2.googleapis.com/token) que incluye los siguientes parámetros:

Campos
client_id El ID de cliente obtenido de API Console.
client_secret El secreto de cliente obtenido de API Console.
grant_type Como se define en la especificación de OAuth 2.0, el valor de este campo debe establecerse en refresh_token.
refresh_token El token de actualización que muestra el intercambio de códigos de autorización.

En el siguiente fragmento, se muestra una solicitud de muestra:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=your_client_id&
client_secret=your_client_secret&
refresh_token=refresh_token&
grant_type=refresh_token

Siempre que el usuario no haya revocado el acceso otorgado a la aplicación, el servidor de tokens mostrará un objeto JSON que contiene un token de acceso nuevo. En el siguiente fragmento, se muestra una respuesta de muestra:

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
  "token_type": "Bearer"
}

Ten en cuenta que existen límites para la cantidad de tokens de actualización que se emitirán: un límite por combinación de cliente y usuario, y otro por usuario para todos los clientes. Guarda los tokens de actualización en el almacenamiento a largo plazo y sigue usándolos mientras sean válidos. Si tu aplicación solicita demasiados tokens de actualización, es posible que alcance estos límites, en cuyo caso los tokens de actualización más antiguos dejarán de funcionar.

Revocación de un token

En algunos casos, es posible que el usuario quiera revocar el acceso otorgado a una aplicación. El usuario puede revocar el acceso a través de la Configuración de la cuenta. Para obtener más información, consulta la sección Cómo quitar el acceso a sitios o apps de la sección Sitios y apps de terceros que tienen acceso a tu cuenta.

También es posible que una aplicación revoque de forma programática el acceso que se le otorgó. La revocación programática es importante en los casos en que un usuario anula la suscripción, quita una aplicación o cambia de forma significativa los recursos de la API que requiere una app. En otras palabras, parte del proceso de eliminación puede incluir una solicitud a la API para garantizar que se quiten los permisos otorgados anteriormente a la aplicación.

Para revocar un token de manera programática, tu aplicación realiza una solicitud a https://oauth2.googleapis.com/revoke e incluye el token como parámetro:

curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
        https://oauth2.googleapis.com/revoke?token={token}

El token puede ser un token de acceso o de actualización. Si se trata de un token de acceso y tiene un token de actualización correspondiente, este también se revocará.

Si la revocación se procesa correctamente, el código de estado HTTP de la respuesta es 200. Para las condiciones de error, se muestra un código de estado HTTP 400 junto con un código de error.

Permisos permitidos

El flujo de OAuth 2.0 para dispositivos solo es compatible con los siguientes alcances:

OpenID Connect, Acceso con Google

  • email
  • openid
  • profile

API de Drive

  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.file

API de YouTube

  • https://www.googleapis.com/auth/youtube
  • https://www.googleapis.com/auth/youtube.readonly