Endpoint de criação de link

Avatar
Product Team
Updated

Endpoint de criação de link

Parâmetros de consulta

Parâmetro Descrição Observações para links de parceiros Observações para links personalizados
app_id O ID do app para o qual você está criando o link. Para ver uma lista dos seus apps, use o endpoint Get Apps. Obrigatório Obrigatório
link_type "partner" ou "custom" (saiba mais sobre links de parceiros vs. personalizados). Obrigatório Obrigatório
partner_id O ID da rede de parceiros para a qual você está criando o link. Para ver uma lista dos parceiros configurados para este app específico, use o endpoint Get Configured Partners. Obrigatório
source_name Especifique "crosspromo", "email", "sms", "social", "affiliates" ou "influencers".
Obrigatório
tracking_link_name Um nome que você dá ao seu Singular Link para identificá-lo posteriormente nos seus relatórios da Singular. A maioria das organizações usa o nome da campanha ou uma variação dele. O tracking_link_name aparecerá nos seus relatórios da Singular como "Tracker Name". Obrigatório Obrigatório
link_dns_zone Os links de rastreamento da Singular têm a seguinte estrutura: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] A zona DNS é "sng.link". Obrigatório Obrigatório
link_subdomain Os links de rastreamento da Singular têm a seguinte estrutura, onde [SUBDOMAIN] é escolhido pela organização: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] Para obter uma lista dos subdomínios configurados para sua organização, chame Get Link Domains. Obrigatório Obrigatório
destination_fallback_url Este é o destino para o qual você deseja levar o usuário se o deep link falhar. Normalmente, se um usuário clicar em um anúncio do seu app, você quer que o deep link o leve a uma tela específica dentro do app. Mas se o usuário ainda não tiver o app instalado, você quer redirecioná-lo para a loja de apps para baixar seu app. Obrigatório Obrigatório
android_redirection

Um objeto contendo parâmetros que especificam para onde o link deve levar em dispositivos Android:

  • app_site_id
  • destination_url
  • destination_deeplink_url (opcional, null por padrão)
  • destination_deferred_deeplink_url (opcional, null por padrão)

Observação: É necessário especificar android_redirection ou ios_redirection. Você só pode especificar ambos se o parceiro da rede permitir vários sistemas operacionais em um único Singular Link.

Obrigatório Obrigatório
ios_redirection

Um objeto contendo parâmetros que especificam para onde o link deve levar em dispositivos iOS:

  • app_site_id
  • destination_url
  • destination_deeplink_url (opcional, null por padrão)
  • destination_deferred_deeplink_url (opcional, null por padrão)

Observação: É necessário especificar android_redirection ou ios_redirection. Você só pode especificar ambos se o parceiro da rede permitir vários sistemas operacionais em um único Singular Link.

Obrigatório Obrigatório
enable_reengagement Defina como true para marcar este link como pertencente a uma campanha de reengajamento (consulte as Perguntas frequentes sobre Reengajamento). Opcional. Observe que nem todos os parceiros oferecem suporte a essa opção. Você pode ver o que o parceiro específico suporta usando uma consulta Get All Partners e especificando o ID do parceiro. Opcional. O reengajamento é suportado para cliques e requer a configuração de redirecionamento de deep-linking.
click_deterministic_window

A janela de atribuição para click-through usando atribuição determinística. Você pode especificar de 0 a 30 dias.

Opcional. Para links de parceiros , o padrão é configurado para cada app site e parceiro na página Partner Configuration. Opcional. Para links personalizados , o padrão é 7 dias.
click_probabilistic_window

A janela de atribuição para click-through usando atribuição probabilística. Você pode especificar de 0 a 24 horas.

Opcional. Para links de parceiros , o padrão é configurado para cada app site e parceiro na página Partner Configuration. Opcional. Para links personalizados , o padrão é 24 horas.
View_deterministic_window

A janela de atribuição para view-through (impressões) usando atribuição determinística. Você pode especificar de 0 a 24 horas. Opcional. Para links de parceiros , o padrão é configurado para cada app site e parceiro na página Partner Configuration. Opcional. Para links personalizados , o padrão é 24 horas.
view_probabilistic_window

A janela de atribuição para view-through (impressões) usando atribuição probabilística. O padrão é 8 horas. Você pode especificar de 0 a 24 horas. Opcional Opcional
click_reengagement_window

A janela de atribuição para click-through em campanhas de reengajamento. Isso só é relevante se enable_reengagement estiver definido como true. Você pode especificar de 0 a 30 dias. Opcional. Para links de parceiros , há um valor padrão definido por parceiro, mas você pode especificar um valor diferente. Opcional. Para links personalizados , o padrão é 7 dias.
enable_ctv

Defina como true para oferecer suporte a campanhas CTV. Isso só é relevante se o parceiro da rede oferecer suporte a campanhas CTV. Dependendo do parceiro, o valor de enable_ctv pode ser true por padrão. Opcional Opcional
og_tags Permite que o link exiba uma visualização de página de destino social.
Exemplo 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 os campos devem ter um valor. 		Indisponível Opcional
disable_short_link_parameters_overrides Quando definido como true, os parâmetros de redirecionamento e deeplink já definidos no link base não podem ser substituídos ao serem anexados ao link curto no momento do clique. Os parâmetros não definidos no link base ainda podem ser anexados como novos valores. Quando false (padrão), os parâmetros anexados podem substituir as configurações do link salvas. Consulte Desabilitando substituições de parâmetros para links curtos para obter todos os detalhes. Indisponível Opcional. Padrão: false. Aplica-se apenas quando o encurtamento de link está habilitado.

Parâmetros de saída

Se o Singular Link foi criado com sucesso, a resposta inclui os seguintes parâmetros:

Parâmetro Descrição
tracking_link_id O ID interno do link de rastreamento. Também está incluído na URL do link de rastreamento.
tracking_link_name O nome que você deu ao link de rastreamento.
click_tracking_link A URL do link de rastreamento para campanhas de click-through. A URL inclui macros que serão substituídas por valores reais pelo parceiro da rede quando o link for veiculado.
impression_tracking_link A URL do link de rastreamento para campanhas de view-through, se suportado.
short_link

Uma versão encurtada da URL do link (apenas para links personalizados).

Observação: Este link é criado usando nosso serviço de link curto, não nosso serviço de Referral Tracking. Esses links curtos não expiram.

No exemplo acima, o link curto é "https://prod_test.sng.link/D75p1/mbm7/961w", onde "961w" é o ID do link curto.

disable_short_link_parameters_overrides O valor desta configuração no link criado. true significa que os parâmetros de redirecionamento e deeplink já definidos no link base estão bloqueados e não podem ser substituídos; false (padrão) significa que podem ser substituídos ao serem anexados ao link curto.
extra_info Mesmo que o link tenha sido criado com sucesso, a Singular pode ter avisos e esclarecimentos para você. Eles são coletados em extra_info.