Esta función está disponible para los clientes Enterprise.

Utilice la nueva API de Enlaces Singulares para crear nuevos Enlaces Singulares, así como para ver sus Enlaces Singulares existentes.

Flujos principales

Uso de la API para crear un enlace de socio

Screen_Shot_2023-01-31_at_13.23.43.png

Para crear un enlace de socio utilizando la API

1	Llame a Get Apps para recuperar las direcciones app_id y app_site_id de la aplicación para la que desea crear un Enlace Singular.
2	Llame a Get Configured Partners para obtener el partner_id del socio de la red publicitaria para el que desea crear un Enlace Singular. Consejo: Sin filtrar, esta consulta devuelve todos los socios que su organización ha configurado para cada app_site_id. Puede utilizar el app_site_id que recuperó en el paso anterior para filtrar la consulta.
3	Llame a Get Link Domains para recuperar las direcciones subdomains y dns_zones que puede utilizar para sus enlaces.
4	Opcionalmente, llame a Get All Partners para obtener más información sobre el socio para el que está creando un enlace, como si admite el uso del mismo enlace para varios sistemas operativos, si admite enlaces de reenganche y si admite CTV. Puede filtrar la consulta por partner_id.
5	Llame a Create Link utilizando los datos app_id, app_site_id, partner_id, subdomain y dns_zone obtenidos en los pasos anteriores. Nota: Si el socio admite el uso del mismo enlace para varios sistemas operativos, puede introducir destinos de enlace para Android y para iOS en el mismo Enlace Singular. De lo contrario, deberá crear un enlace independiente para cada sistema operativo. Si el socio admite la reconexión y/o CTV, puede establecer estas opciones como verdaderas para el enlace único.

Uso de la API para crear un enlace personalizado

Para crear un enlace personalizado utilizando la API

1	Llame a Get Apps para recuperar app_id y app_site_id de la aplicación para la que desea crear un enlace singular.
2	Llame a Get Link Domains para recuperar los subdomains y dns_zones que puedes utilizar para tus enlaces.
3	Llama a Create Link utilizando los app_id, app_site_id, subdomain y dns_zone que recuperó en los pasos anteriores. Nota: La respuesta también incluye una versión abreviada del enlace.

Descripción general de la API de Singular Links

Puntos finales

Están disponibles los siguientes puntos finales de la API:

PUNTO FINAL PRINCIPAL
Create Link	POST	https://api.singular.net/api/v1/singular_links/links
View Links	GET	https://api.singular.net/api/v1/singular_links/links
PUNTOS FINALES DE AYUDA
Get Apps	GET	https://api.singular.net/api/v1/singular_links/apps	Utilícelo para obtener la información necesaria antes de llamar a Create Link o View Links.
Get Configured Partners	GET	https://api.singular.net/api/v1/singular_links/configured_partners
Get Link Domains	GET	https://api.singular.net/api/v1/singular_links/domains	Utilícelo para obtener la información necesaria antes de llamar a Create Link.
Get All Partners	GET	https://api.singular.net/api/v1/singular_links/all_partners	Utilícelo para saber qué opciones admite cada socio.

Autenticación

Todas las llamadas a Singular API requieren su clave de Singular API. Para recuperar su clave, inicie sesión en la plataforma Singular y vaya a Herramientas de desarrollador > Claves de API de informes.

Introduzca la clave de API en el encabezado HTTP de autorización (véanse los ejemplos de código).

Límites

La URL para las solicitudes de obtención de estos puntos finales de API puede tener una longitud máxima de 8000 caracteres. Las URL más largas darán lugar a un mensaje de error.

Crear punto final de enlace

POST

https://api.singular.net/api/v1/singular_links/links

Uso

Utilice este punto final para crear un nuevo Enlace Singular para una de sus redes asociadas o para una fuente personalizada. Una vez creado el enlace, puede utilizarlo como enlace de seguimiento en su campaña con esa red o fuente personalizada.

Para más información, consulte Creating Singular Links y el resto de Preguntas frecuentes sobre enlaces singulares.

Notas:

Al visualizar sus Singular Links en la plataforma Singular, los enlaces creados mediante API no se muestran por defecto. Para mostrarlos, active la opción Show API links.
Se trata de la misma URL de punto final que se utiliza para ver los enlaces existentes, pero aquí se utiliza una solicitud POST en lugar de una solicitud GET, y hay más parámetros obligatorios.

Ejemplo de consulta (Creación de un enlace de socio)

import requests
import json
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  
  api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
  
  params = json.dumps({
    "app_id": <APP_ID>, # From Get Apps call
    "partner_id": <PARTNER_ID>, # From Get Configured Partners call
    "link_type": "partner",
    "tracking_link_name": "my tracking link",
    "link_subdomain": "<SUBDOMAIN>", # From Get Link Domains call
    "link_dns_zone": "sng.link",
    "destination_fallback_url": "https://www.example.com/",
    "android_redirection": {
      "app_site_id": <APP_SITE_ID>, # From Get Apps call
      "destination_url": "https://play.google.com/store/apps/details?id=com.my.app",
      "destination_deeplink_url": "https://www.example.com/",
      "destination_deferred_deeplink_url": "https://www.example.com/"
    }
  })
  
  response = requests.post(url, data=params, headers={'Authorization':api_key})

curl --location --request POST 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'authorization: <API KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "app_id": ,
      "partner_id": ,
      "link_type": "partner",
      "tracking_link_name": "",
      "link_subdomain": "prod_test",
      "link_dns_zone": "sng.link",
      "destination_fallback_url": "https://google.co.il",
      "ios_redirection": {
          "app_site_id": ,
          "destination_url": "",
          "destination_deeplink_url": "",
          "destination_deferred_deeplink_url": ""
      }
  }'

Ejemplo de consulta (Creación de un enlace personalizado)

import requests
import json
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  
  payload = json.dumps({
    "app_id": <...>,
    "partner_id": <...>,
    "link_type": "custom",
    "source_name": "social",
    "enable_reengagement": "false",
    "tracking_link_name": "test-link-custom",
    "link_subdomain": "mydomain",
    "link_dns_zone": "sng.link",
    "destination_fallback_url": "https://fallback.com",
    "click_deterministic_window": 8,
    "click_probabilistic_window": 9,
    "enable_ctv": "false",
    "link_parameter": {
      "this": "is",
      "a": "test"
    },
    "android_redirection": {
      "app_site_id": 609747,
      "destination_url": "https://play.google.com/store/apps/details?id=com.my.app",
      "destination_deeplink_url": "https://example.com",
      "destination_deferred_deeplink_url": "https://example.com"
    }
  })
  headers = {
    'Authorization': '<...>',
    'Content-Type': 'application/json'
  }
  
  response = requests.request("POST", url, headers=headers, data=payload)
  
  print(response.text)

curl --location --request POST 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'Authorization: <...>' \ --header 'Content-Type: application/json' \ --data-raw '{ "app_id": <...>, "partner_id": <...>, "link_type": "custom", "source_name":"social", "enable_reengagement":"false", "tracking_link_name": "test-link-custom", "link_subdomain": "mydomain", "link_dns_zone": "sng.link", "destination_fallback_url": "https://fallback.com", "click_deterministic_window":8, "click_probabilistic_window":9, "enable_ctv":"false", "link_parameter":{ "this":"is", "a":"test" }, "android_redirection": { "app_site_id": 609747, "destination_url": "https://play.google.com/store/apps/details?id=com.my.app", "destination_deeplink_url":"https://example.com", "destination_deferred_deeplink_url": "https://example.com" } }'

Parámetros de consulta

Parámetro	Descripción	Notas sobrelos enlaces de socios	Notas para enlaces personalizados
app_id	El ID de la aplicación para la que está creando el enlace. Para ver una lista de sus aplicaciones, utilice el punto final Get Apps.	Obligatorio	Obligatorio
link_type	"partner" o "custom" (más información sobre enlaces de socios y personalizados).	Obligatorio	Obligatorio
partner_id	ID de la red de socios para la que está creando el enlace. Para ver una lista de los socios configurados para esta aplicación concreta, utilice el punto final Get Configured Partners.	Obligatorio
source_name	Especifique "crosspromo", "email", "sms", "social", "affiliates", or "influencers".		Obligatorio
tracking_link_name	Nombre que da a su Singular Link para identificarlo posteriormente en sus informes Singular. La mayoría de las organizaciones utilizan el nombre de la campaña o una variación del mismo. El tracking_link_name aparecerá en sus informes Singular como "Tracker Name".	Obligatorio	Obligatorio
link_dns_zone	Los enlaces de seguimiento Singular tienen la siguiente estructura: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] La zona DNS es "sng.link".	Exigida	Exigida
link_subdomain	Los enlaces de seguimiento singulares tienen la siguiente estructura, donde [SUBDOMINIO] es elegido por la organización: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] Para obtener una lista de los subdominios que se han configurado para su organización, llame a Get Link Domains.	Exigida	Obligatorio
destination_fallback_url	Es el destino al que desea llevar al usuario si falla el enlace profundo. Normalmente, si un usuario hace clic en un anuncio de su aplicación, querrá que el enlace profundo lo envíe a una pantalla específica dentro de la aplicación. Pero si el usuario aún no tiene instalada la aplicación, querrá redirigirlo a la tienda de aplicaciones para que descargue su aplicación.	Requerido	Requerido
android_redirection	Un objeto que contiene parámetros que especifican a dónde debe llevar el enlace en los dispositivos Android: app_site_id destination_url destination_deeplink_url (opcional, nulo por defecto) destination_deferred_deeplink_url (opcional, nulo por defecto) Nota: Debe especificarse android_redirection o ios_redirection. Puede especificar ambas sólo si el socio de red permite múltiples SO en un Enlace Singular.	Obligatorio	Obligatorio
ios_redirection	Objeto que contiene parámetros que especifican adónde debe llevar el enlace en los dispositivos iOS: app_site_id destination_url destination_deeplink_url (opcional, nulo por defecto) destination_deferred_deeplink_url (opcional, nulo por defecto) Nota: Debe especificarse android_redirection o ios_redirection. Puede especificar ambas sólo si el socio de red permite varios sistemas operativos en un enlace singular.	Obligatorio	Obligatorio
enable_reengagement	Establézcalo como true para marcar este enlace como perteneciente a una campaña de reenganche (consulte las preguntas frecuentes sobre reenganche).	Opcional. Tenga en cuenta que no todos los socios admiten esta opción. Puede ver lo que admite el socio específico utilizando una consulta Obtener todos los socios y especificando el ID del socio.	Opcional. La reconexión es compatible con los clics y requiere la configuración de la redirección de enlace profundo.
click_deterministic_window	La ventana de atribución para clics utilizando la atribución determinista. Puede especificar de 0 a 30 días.	Opcional. Para los enlaces de socios, el valor predeterminado se establece para cada sitio de aplicaciones y socio en la página Configuración de socios.	Opcional. Para los enlaces personalizados, el valor predeterminado es 7 días.
click_probabilistic_window	La ventana de atribución para los clics mediante atribución probabilística. Puede especificar de 0 a 24 horas.	Opcional. Para los enlaces de socios, el valor predeterminado se establece para cada sitio de aplicaciones y socio en la página Configuración de socios.	Opcional. Para los enlaces personalizados, el valor predeterminado es 24 horas.
view_deterministic_window	La ventana de atribución para view-through (impresiones) utilizando la atribución determinista. Puede especificar de 0 a 24 horas.	Opcional. Para los enlaces de socios, el valor predeterminado se establece para cada sitio de aplicaciones y socio en la página Configuración de socios.	Opcional. Para los enlaces personalizados, el valor predeterminado es 24 horas.
view_probabilistic_window	La ventana de atribución para view-through (impresiones) utilizando atribución probabilística. El valor predeterminado es 8 horas. Puede especificar de 0 a 24 horas.	Opcional	Opcional
click_reengagement_window	La ventana de atribución para los clics en campañas de reenganche. Sólo es relevante si enable_reengagement está configurado como true. Puede especificar 0-30 días.	Opcional. Para los enlaces de socios, hay un valor predeterminado establecido por socio, pero puede especificar un valor diferente.	Opcional. Para los enlaces personalizados, el valor predeterminado es 7 días.
enable_ctv	Establézcalo como true para soportar campañas CTV. Esto sólo es relevante si el socio de red admite campañas CTV. Dependiendo del socio, el valor de enable_ctv puede ser true por defecto.	Opcional	Opcional

Ejemplo de salida

{
    "tracking_link_id": "<...>",
    "tracking_link_name": "jr us and ca spring 2022",
    "click_tracking_link": "https://mysubdomain.sng.link/<...>/<...>?idfa=$IDA&and5=$UDID&aifa=$GPID&s=$SITE_APP_ID&psid=$SITE_APP_ID&psn=$SITE_NAME&cl=impId&pcrn=$CREATIVE_NAME&pcrid=$CREATIVE_ID&pcid=$CAMPAIGN_ID&pc=$CAMPAIGN_ID&pcn=$CAMPAIGN_NAME&pscid=$ADGROUP_ID&cr=$CREATIVE_ID&andi1=$O1&pscn=$ADGROUP_NAME&impid=$IMP_ID&pshid=$BLINDED_SITE_ID",
    "impression_tracking_link": "https://i.sng.link/<...>/<...>?idfa=$IDA&and5=$UDID&aifa=$GPID&s=$SITE_APP_ID&psid=$SITE_APP_ID&psn=$SITE_NAME&cl=impId&pcrn=$CREATIVE_NAME&pcrid=$CREATIVE_ID&pcid=$CAMPAIGN_ID&pc=$CAMPAIGN_ID&pcn=$CAMPAIGN_NAME&pscid=$ADGROUP_ID&cr=$CREATIVE_ID&andi1=$O1&pscn=$ADGROUP_NAME&impid=$IMP_ID&pshid=$BLINDED_SITE_ID",
  "short_link": "https://prod_test.sng.link/D75p1/mbm7/961w"
    "extra_info": [
      "partner's default value was used, instead of given argument enable_ctv",
      "partner's default value was used, instead of given argument enable_reengagement"
    ]
  }

Parámetros de salida

Si el Enlace Singular se ha creado correctamente, la respuesta incluye los siguientes parámetros:

Parámetro	Descripción
tracking_link_id	El ID interno del enlace de seguimiento. También se incluye en la URL del enlace de seguimiento.
tracking_link_name	El nombre que ha dado al enlace de seguimiento.
click_tracking_link	La URL del enlace de seguimiento para las campañas de clics. La URL incluye macros que serán sustituidas por valores reales por la red asociada cuando se sirva el enlace.
impression_tracking_link	La URL del enlace de seguimiento para las campañas de visualización, si se admite.
short_link	Una versión abreviada de la URL del enlace (sólo para enlaces personalizados). Nota: Este enlace se crea utilizando nuestro servicio de enlaces cortos, no nuestro servicio de seguimiento de referencias. Estos enlaces cortos no caducan. En el ejemplo anterior, el enlace corto es "https://prod_test.sng.link/D75p1/mbm7/961w" donde "961w" es el ID del enlace corto.
extra_info	Aunque el enlace se haya creado correctamente, Singular puede tener advertencias y aclaraciones para usted. Éstas se recogen en extra_info.

Mensajes de error

Si el enlace NO se ha creado correctamente debido a un problema de configuración, recibirá un mensaje explicando el problema. Arréglelo e intente llamar a Crear Enlace de nuevo.

Mensajede error	Notas
app_site_id no existe
El interlocutor x no está configurado para la aplicación y
link_domain no definido
<attribution_window> valor no admitido	Ha establecido un valor no admitido para una de las ventanas de atribución.
El socio no admite varios sistemas operativos por enlace	Ha intentado establecer valores de redireccionamiento de Android y valores de redireccionamiento de iOS para un socio de red que no admite el uso de un único enlace de seguimiento para varios sistemas operativos.
El socio X no permite enlaces de seguimiento	Las redes de autoatribución (SAN) como Facebook y Google no admiten enlaces de seguimiento y, por lo tanto, Singular no le permite crear Enlaces Singulares para estos socios.

Ver punto final de enlaces

GET

https://api.singular.net/api/v1/singular_links/links

Uso

Utilice este punto final para ver los detalles de sus Enlaces Singulares existentes.

Puede filtrar la solicitud por uno o más de los siguientes campos: app_id, app_site_id, partner_id, source_name y tracking_link_id. Para obtener estos ID, llame a los puntos finales Get Apps y Get Configured Partners.

Nota: Este es el mismo endpoint (URL) que utiliza para crear un nuevo enlace, pero utiliza una petición GET en lugar de una petición POST.

Ejemplo de consulta

import requests
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
          
  # All the parameters are optional. They are used to filter the list of links
  params = {
      "link_type": "partner",
      "partner_id": "<...>",
      "app_id": "<...>",
      "app_site_id": "<...>",
      "tracking_link_id": "abcde"
  }
  
  response = requests.get(url=url, params=params, headers={'Authorization':api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'authorization: <API KEY>'

Parámetros de consulta

Parámetro	Descripción
link_type	[ Opcional ] Si sólo desea ver un tipo de enlace, introduzca "custom", "partner" o "mobile_web_to_app".
partner_id	[ Opcional ] Si sólo desea ver los enlaces de socio configurados para un socio específico, introduzca el ID interno singular del socio.
source_name	[ Opcional ] Si sólo desea ver los enlaces personalizados configurados para una fuente específica.
app_id	[ Opcional ] Si sólo desea ver los enlaces configurados para una aplicación específica, introduzca el ID interno singular de la aplicación.
app_site_id	[ Opcional ] Si sólo desea ver los enlaces configurados para un sitio de aplicación específico, introduzca el ID interno singular del sitio de aplicación.
tracking_link_id	[ Opcional ] Si sólo desea ver los detalles de un enlace singular específico, introduzca el ID del enlace. Puede encontrar el ID en la URL del enlace de seguimiento: https://myapp.sng.link/sdfsdf/abcde?...

Ejemplo de salida

La salida contiene una matriz de todos los Enlaces Singulares que coinciden con sus parámetros de filtrado (si no introdujo ningún parámetro de filtrado, se mostrarán todos los Enlaces Singulares existentes).

[
  {
    'tracking_link_id': '<...>',
    'tracking_link_name': 'My App Android Summer 22',
    'click_tracking_link': 'https://myapp.sng.link/<...>/<...>?idfa={IDFA}&aifa={IDFA}&did={DID}&ip={IP}&pcrn={AD_NAME}&pcid={CAMPAIGN_ID}&pcn={CAMPAIGN_NAME}&pcrid={AD_ID}&pshid={APP_ID}',
    'impression_tracking_link':'https://myapp.sng.link/<...>/<...>?idfa={IDFA}&aifa={IDFA}&did={DID}&ip={IP}&pcrn={AD_NAME}&pcid={CAMPAIGN_ID}&pcn={CAMPAIGN_NAME}&pcrid={AD_ID}&pshid={APP_ID}',
    'created_utc': 'Tue, 23 Aug 2022 12:22:58 GMT',
    'modified_utc': 'Thu, 24 Nov 2022 11:13:41 GMT',
    'link_type': 'partner',
    'partner_id': <...>,
    'app_id': <...>,,
    'android_redirection': {
      'app_site_id': <...>,
      'destination_url': 'https://play.google.com/store/apps/details?id=...',
      'destination_deeplink_url': None,
      'destination_deferred_deeplink': None
    },
    'destination_fallback_url': 'https://www.mywebsite.com',
    'click_deterministic_window': '7 Days',
    'view_deterministic_window': '24 Hours',
    'enable_reengagement': False,
    'enabled_ctv': False,
  },
  ...
]

Parámetros de salida

Una matriz con los siguientes parámetros por enlace:

Parámetro	Descripción
Parámetros generales
tracking_link_id	Un identificador único para el enlace de seguimiento.
tracking_link_name	El nombre dado al enlace cuando se creó.
click_tracking_link	La URL del enlace de seguimiento para los clics.
impression_tracking_link	URL del enlace de seguimiento para la visualización.
created_utc	Hora UTC de creación del enlace.
modified_utc	Fecha y hora UTC de la última modificación del enlace.
link_type	"partner" o "custom"
partner_id	El ID Singular interno único del socio.
app_id	El ID Singular interno de la aplicación.
Destinos delos enlaces
android_redirection	Un objeto que contiene los siguientes parámetros: app_site_id destination_url destination_deeplink_url (opcional, nulo por defecto) destination_deferred_deeplink_url (opcional, nulo por defecto)
ios_redirection	Un objeto que contiene los siguientes parámetros app_site_id destination_url destination_deeplink_url (opcional, nulo por defecto) destination_deferred_deeplink_url (opcional, nulo por defecto)
destination_fallback_url	Es el destino al que desea llevar al usuario si falla el enlace profundo. Normalmente, si un usuario hace clic en un anuncio de tu aplicación, quieres que el enlace profundo lo envíe a una pantalla específica dentro de la aplicación. Pero si el usuario aún no tiene instalada la aplicación, querrá redirigirlo a la tienda de aplicaciones para que descargue su aplicación.
Funcionalidad opcional
enable_reengagement	True si el enlace fue marcado como un enlace utilizado para campañas de reengagement/retargeting.
enabled_ctv	True si el enlace es compatible con campañas de CTV.
Configuración dela ventana de atribución
click_deterministic_window	La ventana de atribución para este enlace en campañas de clics cuando se atribuye a través de métodos deterministas (por ejemplo, haciendo coincidir el ID de dispositivo utilizado para el clic con el ID de dispositivo utilizado para instalar la aplicación).
click_probabilistic_window	La ventana de atribución para este enlace en campañas de clics cuando se atribuye mediante métodos probabilísticos (como la ubicación del dispositivo, el sistema operativo, etc.).
view_deterministic_window	La ventana de atribución para este enlace en campañas de visualización cuando se atribuye mediante métodos deterministas (por ejemplo, haciendo coincidir el ID del dispositivo utilizado para el clic con el ID del dispositivo utilizado para instalar la aplicación).
view_probabilistic_window	La ventana de atribución para este enlace en campañas de visualización cuando se atribuye mediante métodos probabilísticos (como la ubicación del dispositivo, el sistema operativo, etc.).
click_reengagement_window	La ventana de atribución para este enlace en campañas de "click-through reengagement". Este parámetro sólo se incluye si la reconexión está activada para este enlace singular.

Punto final Get Apps

GET

https://api.singular.net/api/v1/singular_links/apps

Uso

Utilice este punto final para obtener una lista de todos sus sitios de aplicaciones configurados en Singular (consulte ¿Cuál es la diferencia entre una aplicación y un sitio de aplicaciones?).

Ejemplo de consulta

import requests

url = "https://api.singular.net/api/v1/singular_links/apps"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

response = requests.get(url=url, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/apps?api_key=<API KEY>'

Ejemplo de salida

{
  'available_apps': [
    {
      'app_site_id': <...>,
      'app_platform': 'ios',
      'app_store_url': 'https://itunes.apple.com/us/app/…',
      'site_public_id': '<...>',
      'app_id': <...>,
      'app': 'My App'
    },
    {
      'app_site_id': <...>,
      'app_platform': 'android',
      'app_store_url': 'https://play.google.com/store/apps/details?id=...',
      'site_public_id': 'com.rovio.baba',
      'app_id': <...>,
      'app': 'My App'
    }
  ]
}

Parámetros de salida

La respuesta es una matriz de sitios de aplicaciones con los siguientes parámetros para cada sitio de aplicaciones:

Parámetro	Descripción
app_site_id	ID interno de Singular para el sitio de aplicaciones (app + OS + ID de paquete) (consulte ¿Cuál es la diferencia entre una aplicación y un sitio de aplicaciones?).
app_platform	La plataforma definida para el sitio de aplicaciones, por ejemplo, iOS.
app_store_url	La URL de la aplicación en Google Play o Apple App Store.
site_public_id	Se trata del identificador de la aplicación en Apple App Store o Google Play (consulte ¿Cuál es la diferencia entre una aplicación y un sitio de aplicaciones?). En el caso de los sitios web, se trata de la URL del sitio web.
app_bundle_id	El identificador interno de la aplicación, por ejemplo, "com.myapp".
app_id	El identificador interno de Singular para la app en Singular.
app	El nombre de la aplicación configurado en la página Aplicaciones .

Obtener punto final de socios configurados

GET	https://api.singular.net/api/v1/singular_links/configured_partners

Uso

Recupera una lista de los socios (redes publicitarias) que ha configurado para cada sitio de aplicaciones. Puede filtrar la solicitud a sitios de aplicaciones y socios específicos.

Nota: la lista no incluirá socios como Facebook, Google Ads u otras redes de autoatribución (SAN) que no admitan vínculos singulares.

Ejemplo de consulta

import requests        
        
url = "https://api.singular.net/api/v1/singular_links/configured_partners"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
        
params = {
  # The app sites for which you want to see which partners are configured
  "app_site_id": "<APP_SITE_ID1>,<APP_SITE_ID2>",

  # Optional filtering parameter
  "partner_id": "<PARTNER_ID1>,<PARTNER_ID2>" 
}

response = requests.get(url=url, params=params, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/configured_partners?api_key=<api_key>&app_site_id=<app_site_id>'

Parámetros de consulta

Parámetro	Descripción
app_site_id	[ Opcional ] Un ID de sitio de aplicación o una lista de ID de sitios de aplicación separados por comas, para filtrar la lista.
partner_id	[ Opcional ] Un ID de socio o una lista de ID de socios separados por comas, para filtrar la lista.

Ejemplo de salida

A continuación se muestra un ejemplo de una solicitud filtrada por app_site_id = "22334". Hay dos socios configurados para este sitio de aplicaciones.

{
  'available_partners': [
    {
      'app_site_id': <...>,
      'app_id': <...>,
      'singular_partner_display_name':'AdWords',
      'singular_partner_id':<...>
    },
    {
      'app_site_id': <...>,
      'app_id': <...>,
      'singular_partner_display_name':'SplitMetrics',
      'singular_partner_id':<...>,

    }
  ] 
}

Parámetros de salida

Un array de sitios de aplicación con los siguientes parámetros por sitio de aplicación::

Parámetro	Descripción
app_site_id	ID interno de Singular para el sitio de la aplicación.
app_id	ID interno de Singular para la aplicación.
singular_partner_display_name	El nombre del socio en Singular, por ejemplo, "IronSource".
singular_partner_id	ID interno de Singular para el socio.

Obtener todos los socios

GET

https://api.singular.net/api/v1/singular_links/all_partners

Uso

Obtenga detalles sobre los socios configurados para su organización.

Puede filtrar la solicitud por un ID de socio o por varios ID de socios para obtener detalles sólo sobre socios específicos.

Nota: La lista no incluirá socios como Facebook, Google Ads u otras redes de autoatribución (SAN) que no admitan vínculos singulares.

Ejemplo de consulta

import requests        

url = "https://api.singular.net/api/v1/singular_links/all_partners"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

params = {
  #Optional: filter to see specific partner(s)
  "partner_id": "<PARTNER_ID1>,<PARTNER_ID2>" 
}

response = requests.get(url=url, params=params, headers={'Authorization':api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/all_partners' \
--header 'authorization: <API KEY>'

Parámetros de consulta

Parámetro	Descripción
singular_partner_id	[ Opcional] Lista separada por comas de ID de socios sobre los que mostrar detalles.

Ejemplo de salida

{
  'partners': [
    {
      'singular_partner_id': <...>,
      'singular_partner_display_name': 'One Network',
      'support_multiple_os': True,
      'support_reengagement': True,
      'support_ctv': False,
    },
    {
      'singular_partner_id': <...>,
      'singular_partner_display_name': 'Other Network',
      'support_multiple_os': False,
      'support_reengagement': True,
      'support_ctv': True,
    },

    ...
         
  ]
}

Parámetros de salida

Una matriz de socios con los siguientes parámetros por socio:

Parámetro	Descripción
singular_partner_id	ID interno de Singular para el socio.
singular_partner_display_name	El nombre del socio en Singular, por ejemplo, "IronSource".
support_multiple_os	Verdadero si el socio permite definir un destino iOS y un destino Android en el mismo enlace de seguimiento. Si el socio lo admite, puede crear un enlace Singular que se utilizará en campañas para ambos sistemas operativos.
support_reengagement	Verdadero si el socio admite enlaces de reenganche. Si el socio lo admite, puede crear un enlace singular marcado como enlace de reenganche y utilizarlo en su campaña de retargeting.
support_ctv	Verdadero si el socio admite CTV. Si el socio lo admite, puede crear enlaces que admitan CTV.

Obtener dominio de enlace

GET

https://api.singular.net/api/v1/singular_links/domains

Uso

Recupera una lista de sus dominios de enlaces singulares. Los enlaces de seguimiento Singular tienen la siguiente estructura, donde [SUBDOMINIO] es elegido por usted, y la zona DNS es "sng.link":

https://[SUBDOMAIN].sng.link/[PARAMETERS]

Cuando cree un enlace Singular, deberá especificar el subdominio y la zona DNS que se utilizarán en la URL del enlace.

Consejo: Los dominios de los enlaces se crean en la plataforma Singular en Atribución > Gestionar enlaces. Tiene que definir al menos un dominio antes de poder crear cualquier enlace Singular.

Ejemplo de consulta

import requests        

url = "https://api.singular.net/api/v1/singular_links/domains"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

response = requests.get(url=url, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/domains?api_key=<api_key>'

Ejemplo de salida

Esta solicitud devuelve una lista de los dominios de Singular Links creados para su organización.

{
  'available_domains': [
    {
      'subdomain': 'myorg',
      'dns_zone': 'sng.link'
    }, 
    {
      'subdomain': 'awesomeapp',
      'dns_zone': 'sng.link'
      }
  ]
}

Parámetros de salida

Parámetro	Descripción
subdominio	El nombre que le ha dado al subdominio, por ejemplo, el nombre de su empresa. Junto con dns_zone, crea el dominio que se utilizará en Singular Links.
dns_zone	"sng.link"

API de enlace de rastreo singular

Flujos principales

Uso de la API para crear un enlace de socio

Uso de la API para crear un enlace personalizado

Descripción general de la API de Singular Links

Puntos finales

Autenticación

Límites

Crear punto final de enlace

Uso

Ejemplo de consulta (Creación de un enlace de socio)

Ejemplo de consulta (Creación de un enlace personalizado)

Parámetros de consulta

Ejemplo de salida

Parámetros de salida

Mensajes de error

Ver punto final de enlaces

Uso

Ejemplo de consulta

Parámetros de consulta

Ejemplo de salida

Parámetros de salida

Punto final Get Apps

Uso

Ejemplo de consulta

Ejemplo de salida

Parámetros de salida

Obtener punto final de socios configurados

Uso

Ejemplo de consulta

Parámetros de consulta

Ejemplo de salida

Parámetros de salida

Obtener todos los socios

Uso

Ejemplo de consulta

Parámetros de consulta

Ejemplo de salida

Parámetros de salida

Obtener dominio de enlace

Uso

Ejemplo de consulta

Ejemplo de salida

Parámetros de salida