API de OneLink

Premium
Para:
Marketers Desarrolladores
Última actualización:

De un vistazo: La API de OneLink te ayuda a involucrar a usuarios finales y aprovechar medios propios generando enlaces personalizados en campañas de gran escala, a través de SMS y 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:

  • Crear, obtener, actualizar y eliminar las URL cortas de OneLink con parámetros personalizados automáticamente.
    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 un 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).
  • Generar un gran número de enlaces de atribución personalizados de OneLink al instante.
    Nota: Para los enlaces de recomendación, consulta el artículo Atribución de invitaciones de usuarios. 

 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 de la API de OneLink que puedes realizar es limitada según el tipo de cuenta. Puedes ver cuántas consultas hiciste y cuántas te quedan en el panel de control de la API de OneLink. 

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

instalación

Para configurar la API de OneLink:

  1. Crea una plantilla de OneLink.
  2. Registrar el ID de OneLink. 

  3. Registra la clave de API de OneLink. Un usuario administrador debe recuperar la clave de API; los usuarios de la cuenta no tienen acceso. 
    • En el panel de control de AppsFlyer, ve a Experiencias y enlaces profundos > API de OneLink > Ver clave API de OneLink.
    • Si la clave de API de OneLink no está disponible para un usuario administrador, significa que no tienes el paquete necesario y debes comunicarte con tu CSM.
  4. Proporciona el ID de OneLink y la clave de la API de OneLink al desarrollador.
  5. Dile al desarrollador que siga las instrucciones del centro de desarrollo.

Panel de control

El panel de control de la API de OneLink muestra:

  • Tu uso de API diario, mensual y trimestral. 
  • La clave de API de OneLink.

Para ver el panel de control de la API de OneLink: 

En AppsFlyer, ve a Experiencias y enlaces profundos > API de OneLink.

Rasgos y limitaciones

Característica

Observaciones

Límite de cuota de API
  • El límite de uso de 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 realicen después de superar esta cuota, y no se crean los enlaces; la llamada de la API recibe el código de estado de error 429 con el mensaje "Cuota mensual excedida."
  • La información relacionada con el límite de cuota usada/restante se muestra en el panel de control de la API de OneLink. 

Límite de velocidad
  • El límite de cuota de API por cuenta es de 500 solicitudes por segundo (30 000 por minuto).
  • No se atienden las solicitudes realizadas que superen las 500 solicitudes por segundo (30 000 por minuto) , y no se crean los enlaces; la llamada de la API recibe el código de estado de error 429 con el mensaje "Límite de cuota excedido."

Visibilidad de los enlaces
  • Los enlaces creados a través de la API no aparecen en la lista de enlaces personalizados de OneLink en el dashboard de AppsFlyer.
  • Prácticas recomendadas: Guardar los enlaces creados con la API a una tabla local, para que puedas acceder a los enlaces para cualquier fin futuro. 

TTL 
  • El tiempo de vida predeterminado (TTL) para las URL cortas de OneLink creadas a través de la API de OneLink es de 31 días. Se extiende por 31 días cada vez que se hace clic en el enlace. Hacer clic en dicho enlace una vez que el TTL vence sigue siendo el comportamiento predeterminado definido en la configuración base de OneLink, pero la atribución no funcionará.
    • Puede tomar hasta 48 horas para que una URL corta de OneLink se elimine después de que expire el TTL.
  • El TTL máximo es de 31 días. Cualquier valor del TTL mayor que 31 se reemplaza por el TTL predeterminado de 31.
  • Puedes cambiar el TTL predeterminado agregando el parámetro ttl={value} y especificando cuántos 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 el enlace existente) 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 un TTL 2d para un enlace que actualmente tiene un TTL 29d, cambiará a TTL=2d (no a 31d).
    • Una llamada de actualización puede prolongar potencialmente la vida útil del enlace de atribución. Por ejemplo, si realizas una llamada de actualización con un TTL 31d para un enlace que actualmente tiene un TTL 20d pero han pasado 5 días, el TTL será 31d desde el momento de la actualización.
  • Si no deseas que los TTL de enlaces se extiendan automáticamente, agrega el parámetro renew_ttl=false a tus enlaces. El valor para este parámetro es booleano, ya sea verdadero (predeterminado) o falso.
  • El parámetro renew_ttl no se muestra en la URL real.

Caracteres especiales

 Los siguientes caracteres deben estar codificados si se utilizan para enlaces creados por la API: ;, *, !, @, #, ?, $, ^, :, &, ~, `, =, +, ’, >, <, /
Si no codificas estos caracteres, se reemplazan con un espacio en blanco, y el enlace y su funcionalidad podrían fallar.

Carga útil

La cadena de consulta de la carga útil no puede superar los 2048 caracteres.

ID de URL

El ID de URL (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 ID de la URL no debe superar los 50 caracteres y puede ser una combinación de letras y números. De forma predeterminada, tiene 8 caracteres.

Nota:

  • Solo puedes editar el ID de la URL si el ID actual aún no está en uso.
  • Si el ID de URL ya está en uso, la creación del enlace falla y devuelve una respuesta de error (400). Tú y tu desarrollador deben decidir y configurar lo que sucede en tal evento.
  • La llamada fallida sigue contando para tu cuota mensual de API.