API de OneLink

Premium

Para:

Última actualización: 15 de noviembre de 2024 14:36

En resumen: La API de OneLink te ayuda a captar la atención de los usuarios finales y a aprovechar los medios propios mediante la generación de enlaces personalizados en campañas a gran escala, a través de SMS y mucho más. Requiere la implementación tanto por parte del anunciante como por parte del desarrollador.

API de OneLink

La API de OneLink se utiliza para:

Crea, obtiene, actualiza y elimina automáticamente las URLs cortas de OneLink con parámetros personalizados.
Los parámetros pueden ser:
- Los parámetros relacionados con la atribución, usados para medir y monitorear esfuerzos de marketing, como fuentes de medios, campañas y activos. Nota: El parámetro de la fuente de medios (pid) es obligatorio.
- Parámetros de personalización, que te permiten configurar una experiencia de usuario personalizada cuando se abre la aplicación desde el enlace correspondiente. Estos parámetros te permiten enviar a los usuarios a contenido personalizado in-app, por ejemplo, una página de producto específica, un código de cupón o una promoción.
Permitir que se comparta el contenido del sitio web y la aplicación directamente con los usuarios de dispositivos móviles (aumentando así el engagement y las instalaciones).
Genera una gran cantidad de enlaces de atribución personalizados de OneLink al instante.
Nota: Para ver los enlaces de referencia, consulta el artículo sobre atribución de invitaciones de usuario.

Ejemplo

Feed Me, un servicio de entrega de comestibles, desea enviar un enlace vía SMS a clientes existentes para animarlos a descargar la aplicación de Feed Me y comprar bananas. Según el país del cliente, Feed Me usa la API REST de OneLink para crear una URL personalizada de OneLink que contenga detalles específicos para el país, la identidad del usuario y una oferta especial para las bananas que están en oferta.

La cantidad de consultas a la API de OneLink que puedes realizar está limitada en función del tipo de cuenta. Puedes ver cuántas consultas has realizado y cuántas te quedan en el dashboard de la API de OneLink.

Puedes ponerte en contacto con tu CSM para aumentar el límite de consultas a la API.

Configuración

Para configurar la API de OneLink:

Crea una plantilla de OneLink.
Copia el ID de la plantilla de OneLink.
Copia el token de la API de OneLink. Por motivos de seguridad, un usuario «Admin» debe recuperar el token; los usuarios de la cuenta no tienen acceso.
Proporciona el ID de OneLink y el token de la API de OneLink al desarrollador.
Dile al desarrollador que siga las instrucciones del centro de desarrollo.

Dashboard

El dashboard de la API de OneLink muestra nuestro uso diario, mensual y trimestral de la API.

Para ver el dashboard de la API de OneLink:

En AppsFlyer, en el menú lateral, selecciona Engage > API de OneLink.

Características y limitaciones

Característica	Observaciones
Límite de cuota de la API	El límite para usar la API de OneLink para crear, editar o eliminar enlaces de OneLink es de 7,5 millones al mes (zona horaria UTC), por cuenta. No se atienden todas las solicitudes que se realizan después de superar esta cuota y no se crean los enlaces; la llamada a la API recibe el código de estado de error 429 con el mensaje «Se ha superado la cuota mensual». La información sobre la cantidad de la cuota que se utiliza o permanece se muestra en el dashboard de la API de OneLink.
Límite de velocidad	El límite de velocidad de la API por cuenta es de 500 solicitudes por segundo (30.000 por minuto). Todas las solicitudes que superen las 500 solicitudes por segundo (30.000 por minuto) no se atienden y los enlaces no se crean; la llamada a la API recibe el código de estado de error 429 con el mensaje «Se ha superado el límite de velocidad».
Visibilidad de los enlaces	Los enlaces creados mediante la API no aparecen en la lista de enlaces personalizados de OneLink en el dashboard de AppsFlyer. Prácticas recomendadas: Guarda los enlaces creados por la API en una tabla local para poder acceder a los enlaces para cualquier propósito futuro.
TTL	El tiempo de vida (TTL) predeterminado para las URLs cortas de OneLink creadas mediante la API de OneLink es de 31 días. Se extiende 31 días cada vez que se hace clic en el enlace. Al hacer clic en un enlace una vez que el TTL caduca, se sigue utilizando de forma predeterminada el comportamiento definido en la configuración básica de OneLink, pero la atribución no funcionará. Una vez que caduque el TTL, una URL corta de OneLink puede tardar hasta 48 horas en eliminarse. El TTL máximo es de 31 días. Cualquier valor TTL superior a 31 se anula con el TTL predeterminado de 31. Puedes cambiar el TTL predeterminado añadiendo el parámetro `ttl={value}` y especificando el número de días, horas o minutos. Por ejemplo `ttl=7d`, `ttl=12h`, o `ttl=10m`. Puedes enviar una solicitud de actualización para especificar el TTL. Cualquier solicitud de actualización restablece el TTL (para los enlaces existentes) al especificado en el cuerpo de la solicitud. Esto significa que se reemplaza el TTL. Por ejemplo, si realizas una llamada de actualización con TTL 2d para un enlace que actualmente tiene TTL 29d, cambiará a TTL=2d (no a 31d). Una llamada de actualización puede alargar la vida útil del enlace de atribución. Por ejemplo, si realizas una llamada de actualización con TTL 31d para un enlace que actualmente tiene TTL 20d pero han pasado 5 días, el TTL será de 31d desde el momento de la actualización. Si no quieres que los TTL de los enlaces se extiendan automáticamente, agrega el parámetro`renew_ttl=false` a tus enlaces. El valor de este parámetro es booleano, verdadero (predeterminado) o falso. El parámetro `renew_ttl`no aparece en la URL actual.
Caracteres especiales	Los siguientes caracteres deben codificarse si se utilizan para los enlaces creados por la API: ;, , !, @, #, ?, $, ^, :, &, ~, `, =, +, ’, >, <, / Si no codificas estos caracteres, se sustituyen por un espacio en blanco y el enlace y su funcionalidad podrían interrumpirse. Nota:* Los 3 parámetros siguientes no se decodificarán al hacer clic en el enlace y permanecerán codificados: `af_dp` `deep_link_value` `deep_link_sub1`
Payload	La cadena de consulta de payload no puede superar los 2048 caracteres.
URL ID	El URL ID (o ID de enlace corto) se puede editar para resaltar la oferta de tu campaña. Por ejemplo: https://myapp.onelink.me/abc123/apples. El URL ID no debe superar los 50 caracteres y puede ser una combinación de letras y números. Por defecto, tiene 8 caracteres. Nota: Solo puedes editar el URL ID si el ID actual aún no está en uso. Si el URL ID ya está en uso, se produce un error al crear el enlace y se devuelve una respuesta de error (400). Tú y tu desarrollador tenéis que decidir y configurar lo que ocurrirá en tal caso. Una llamada fallida sigue contando para tu cuota mensual de la API.