Endpoint de creación de enlaces

Avatar
Product Team
Updated

Endpoint de creación de enlaces

Parámetros de consulta

Parámetro Descripción Notas para enlaces de partner Notas para enlaces personalizados
app_id El ID de la aplicación para la cual estás creando el enlace. Para ver una lista de tus aplicaciones, usa el endpoint Get Apps. Obligatorio Obligatorio
link_type "partner" o "custom" (obtén más información sobre enlaces de partner vs. personalizados). Obligatorio Obligatorio
partner_id El ID de la red de partner para la cual estás creando el enlace. Para ver una lista de los partners configurados para esta aplicación en particular, usa el endpoint Get Configured Partners. Obligatorio
source_name Especifica "crosspromo", "email", "sms", "social", "affiliates" o "influencers".
Obligatorio
tracking_link_name Un nombre que le das a tu Singular Link para identificarlo más adelante en tus reportes de Singular. La mayoría de las organizaciones usan el nombre de la campaña o una variación del mismo. El tracking_link_name aparecerá en tus reportes de Singular como "Tracker Name". Obligatorio Obligatorio
link_dns_zone Los enlaces de tracking de Singular tienen la siguiente estructura: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] La zona DNS es "sng.link". Obligatorio Obligatorio
link_subdomain Los enlaces de tracking de Singular tienen la siguiente estructura, donde [SUBDOMAIN] es elegido por la organización: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] Para obtener una lista de los subdominios configurados para tu organización, llama a Get Link Domains. Obligatorio Obligatorio
destination_fallback_url Este es el destino al que quieres llevar al usuario si el deep link falla. Normalmente, si un usuario hace clic en un anuncio de tu aplicación, quieres que el deep link lo lleve a una pantalla específica dentro de la aplicación. Pero si el usuario aún no tiene la aplicación instalada, querrás redirigirlo a la tienda de aplicaciones para que descargue tu aplicación. Obligatorio Obligatorio
android_redirection

Un objeto que contiene parámetros que especifican adónde debe llevar el enlace en dispositivos Android:

  • app_site_id
  • destination_url
  • destination_deeplink_url (opcional, null por defecto)
  • destination_deferred_deeplink_url (opcional, null por defecto)

Nota: Se debe especificar android_redirection o ios_redirection. Solo puedes especificar ambos si el partner de la red permite múltiples SO en un único Singular Link.

Obligatorio Obligatorio
ios_redirection

Un objeto que contiene parámetros que especifican adónde debe llevar el enlace en dispositivos iOS:

  • app_site_id
  • destination_url
  • destination_deeplink_url (opcional, null por defecto)
  • destination_deferred_deeplink_url (opcional, null por defecto)

Nota: Se debe especificar android_redirection o ios_redirection. Solo puedes especificar ambos si el partner de la red permite múltiples SO en un único Singular Link.

Obligatorio Obligatorio
enable_reengagement Establece en true para marcar este enlace como perteneciente a una campaña de reengagement (consulta las Preguntas frecuentes sobre Reengagement). Opcional. Ten en cuenta que no todos los partners admiten esta opción. Puedes ver qué admite el partner específico utilizando una consulta Get All Partners y especificando el ID del partner. Opcional. El re-engagement es compatible con los clics y requiere configurar la redirección de deep-linking.
click_deterministic_window

La ventana de atribución para click-through usando atribución determinística. Puedes especificar de 0 a 30 días.

Opcional. Para enlaces de partner , el valor predeterminado se configura para cada app site y partner en la página Partner Configuration. Opcional. Para enlaces personalizados , el valor predeterminado es 7 días.
click_probabilistic_window

La ventana de atribución para click-through usando atribución probabilística. Puedes especificar de 0 a 24 horas.

Opcional. Para enlaces de partner , el valor predeterminado se configura para cada app site y partner en la página Partner Configuration. Opcional. Para enlaces personalizados , el valor predeterminado es 24 horas.
View_deterministic_window

La ventana de atribución para view-through (impresiones) usando atribución determinística. Puedes especificar de 0 a 24 horas. Opcional. Para enlaces de partner , el valor predeterminado se configura para cada app site y partner en la página Partner Configuration. Opcional. Para enlaces personalizados , el valor predeterminado es 24 horas.
view_probabilistic_window

La ventana de atribución para view-through (impresiones) usando atribución probabilística. El valor predeterminado es 8 horas. Puedes especificar de 0 a 24 horas. Opcional Opcional
click_reengagement_window

La ventana de atribución para click-through en campañas de reengagement. Esto solo es relevante si enable_reengagement está establecido en true. Puedes especificar de 0 a 30 días. Opcional. Para enlaces de partner , hay un valor predeterminado establecido por partner, pero puedes especificar un valor diferente. Opcional. Para enlaces personalizados , el valor predeterminado es 7 días.
enable_ctv

Establece en true para admitir campañas CTV. Esto solo es relevante si el partner de la red admite campañas CTV. Dependiendo del partner, el valor de enable_ctv puede ser true por defecto. Opcional Opcional
og_tags Permite que el enlace muestre una vista previa de la landing page social.
Ejemplo de valor
{
"title": "my Title",
"description": "my Description",
"image_url": "https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2@2x.png"
}

Todos los campos deben tener un valor. 		No disponible Opcional
disable_short_link_parameters_overrides Cuando se establece en true, los parámetros de redirección y deeplink ya establecidos en el enlace base no pueden ser sobrescritos al agregarlos al enlace corto en el momento del clic. Los parámetros no establecidos en el enlace base aún pueden añadirse como nuevos valores. Cuando es false (predeterminado), los parámetros añadidos pueden sobrescribir la configuración guardada del enlace. Consulta Deshabilitación de la sobrescritura de parámetros para enlaces cortos para obtener todos los detalles. No disponible Opcional. Predeterminado: false. Solo se aplica cuando está habilitado el acortamiento de enlaces.

Parámetros de salida

Si el Singular Link se creó correctamente, la respuesta incluye los siguientes parámetros:

Parámetro Descripción
tracking_link_id El ID interno del enlace de tracking. También se incluye en la URL del enlace de tracking.
tracking_link_name El nombre que le diste al enlace de tracking.
click_tracking_link La URL del enlace de tracking para campañas de click-through. La URL incluye macros que serán reemplazadas con valores reales por el partner de la red cuando se sirva el enlace.
impression_tracking_link La URL del enlace de tracking para campañas de view-through, si es compatible.
short_link

Una versión acortada del enlace (solo para enlaces personalizados).

Nota: Este enlace se crea utilizando nuestro servicio de enlaces cortos, no nuestro servicio de Referral Tracking. Estos enlaces cortos no expiran.

En el ejemplo anterior, el enlace corto es "https://prod_test.sng.link/D75p1/mbm7/961w", donde "961w" es el ID del enlace corto.

disable_short_link_parameters_overrides El valor de esta configuración en el enlace creado. true significa que los parámetros de redirección y deeplink ya establecidos en el enlace base están bloqueados y no pueden ser sobrescritos; false (predeterminado) significa que pueden ser sobrescritos al agregarlos al enlace corto.
extra_info Aunque el enlace se haya creado correctamente, Singular puede tener advertencias y aclaraciones para ti. Estas se recopilan en extra_info.