Esse recurso está disponível para clientes Enterprise.
Use a nova API de Singular Links para criar novos Singular Links e visualizar os Singular Links existentes.
Fluxos principais
Uso da API para criar um link de parceiro
Para criar um link de parceiro usando a API:
| 1 |
Chamada Get Apps para recuperar os endereços app_id e app_site_id do aplicativo para o qual você deseja criar um link único. |
| 2 |
Ligue para Get Configured Partners para obter o endereço partner_id do parceiro da rede de anúncios para o qual você deseja criar um Singular Link. Dica: Sem filtro, essa consulta retorna todos os parceiros que sua organização configurou para cada app_site_id. Você pode usar o app_site_id que recuperou na etapa anterior para filtrar a consulta. |
| 3 | Chame Get Link Domains para recuperar o subdomains e o dns_zones que você pode usar em seus links. |
| 4 | Opcionalmente, chame Get All Partners para obter mais informações sobre o parceiro para o qual você está criando um link, como, por exemplo, se ele suporta o uso do mesmo link para vários sistemas operacionais, se suporta links de reengajamento e se suporta CTV. Você pode filtrar a consulta por partner_id. |
| 5 |
Chamada Create Link usando os endereços app_id, app_site_id, partner_id, subdomain e dns_zone que você recuperou nas etapas anteriores. Observação: se o parceiro aceitar o uso do mesmo link para vários sistemas operacionais, você poderá inserir destinos de link para Android e iOS no mesmo link único. Caso contrário, você precisará criar um link separado para cada sistema operacional. Se o parceiro oferecer suporte a reengajamento e/ou CTV, você poderá definir essas opções como verdadeiras para o Singular Link. |
Uso da API para criar um link personalizado
Para criar um link personalizado usando a API:
| 1 |
Ligue para Get Apps para recuperar os endereços app_id e app_site_id do aplicativo para o qual você deseja criar um Singular Link. |
| 2 | Ligue para Get Link Domains para recuperar o subdomains e o dns_zones que você pode usar para seus links. |
| 3 |
Ligue para Create Link usando o app_id, app_site_id, subdomain e o dns_zone que você recuperou nas etapas anteriores. Observação: A resposta também inclui uma versão abreviada do link. |
Visão geral da API do Singular Links
Pontos de extremidade
Os seguintes pontos de extremidade da API estão disponíveis:
| PONTO FINAL PRINCIPAL | |||
| Create Link | POST | https://api.singular.net/api/v1/singular_links/links | |
| View Links | GET | ||
| PONTOS DE EXTREMIDADE AUXILIARES | |||
| Get Apps | GET | https://api.singular.net/api/v1/singular_links/apps | Use para obter as informações necessárias antes de chamar Create Link ou 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 | Use para obter as informações necessárias antes de ligar para Create Link. |
| Get All Partners | GET | https://api.singular.net/api/v1/singular_links/all_partners | Use para saber quais opções são compatíveis com cada parceiro. |
Autenticação
Todas as chamadas à API da Singular exigem sua chave de API da Singular. Para recuperar sua chave, faça login na plataforma Singular e vá para Developer Tools > Reporting API Keys.
Coloque a chave da API no cabeçalho HTTP de autorização (consulte os exemplos de código).
Limites
O URL para obter solicitações para esses pontos de extremidade da API pode ter até 8.000 caracteres. URLs mais longos resultarão em uma mensagem de erro.
Criar ponto de extremidade de link
| POST | https://api.singular.net/api/v1/singular_links/links |
Uso
Use esse endpoint para criar um novo Singular Link para uma de suas redes de parceiros ou para uma fonte personalizada. Depois de criar o link, você poderá usá-lo como um link de rastreamento em sua campanha com essa rede ou fonte personalizada.
Para obter mais informações, consulte Creating Singular Links e o restante das Perguntas frequentes sobre Singular Links.
Observações:
- Ao visualizar seus Singular Links na plataforma Singular, os links criados pela API não são exibidos por padrão. Para exibi-los, ative a opção Show API links.
- Esse é o mesmo URL de endpoint usado para visualizar seus links existentes, mas aqui você usa uma solicitação POST em vez de uma solicitação GET, e há mais parâmetros necessários.
Exemplo de consulta (criação de um link de parceiro)
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": ""
}
}'Exemplo de consulta (criação de um link 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 da consulta
| Parâmetro | Descrição | Notas sobre links de parceiros | Notas para links personalizados |
|---|---|---|---|
| app_id | O ID do aplicativo para o qual você está criando o link. Para ver uma lista de seus aplicativos, use o ponto de extremidade Get Apps. | Obrigatório | Obrigatório |
| link_type | "partner" ou "custom" (saiba mais sobre links de parceiros versus links 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 esse aplicativo específico, use o ponto de extremidade Get Configured Partners. | Obrigatório |
|
| source_name | Especifique "crosspromo", "email", "sms", "social", "affiliates", or "influencers". |
Obrigatório |
|
| tracking_link_name | Um nome que você dá ao seu Singular Link para identificá-lo posteriormente em seus relatórios do Singular. A maioria das organizações usa o nome da campanha ou uma variação do nome da campanha. O tracking_link_name aparecerá em seus relatórios do Singular como "Tracker Name" (Nome do rastreador). | 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 únicos têm a seguinte estrutura, em que [SUBDOMAIN] é escolhido pela organização: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] Para obter uma lista dos subdomínios que foram configurados para sua organização, ligue para Get Link Domains. | Obrigatório | Obrigatório |
| destination_fallback_url | Esse é 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 aplicativo, você deseja que o link direto o envie para uma tela específica dentro do aplicativo. Mas se o usuário ainda não tiver o aplicativo instalado, você deseja redirecioná-lo para a loja de aplicativos para fazer o download do aplicativo. | Obrigatório | Obrigatório |
| android_redirection |
Um objeto que contém parâmetros que especificam para onde o link deve levar em dispositivos Android:
Observação: Deve-se especificar android_redirection ou ios_redirection. Você pode especificar ambos somente se o parceiro de rede permitir vários sistemas operacionais em um único link. |
Obrigatório |
Obrigatório |
| ios_redirection |
Um objeto que contém parâmetros que especificam para onde o link deve levar em dispositivos iOS:
Observação: Deve-se especificar android_redirection ou ios_redirection. Você pode especificar ambos somente se o parceiro de rede permitir vários sistemas operacionais em um único link. |
Obrigatório |
Obrigatório |
| enable_reengagement |
Defina como true para marcar esse link como pertencente a uma campanha de reengajamento (consulte as Perguntas frequentes sobre reengajamento) |
Opcional. Observe que nem todos os parceiros aceitam 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 é compatível com cliques e requer a configuração do redirecionamento de links diretos. |
|
click_deterministic_window |
A janela de atribuição para cliques usando a atribuição determinística. Você pode especificar de 0 a 30 dias.
|
Opcional. Para links de parceiros, o padrão é configurado para cada site de aplicativo e parceiro na página Configuração de parceiros. |
Opcional. Para links personalizados, o padrão é 7 dias. |
|
click_probabilistic_window |
A janela de atribuição para cliques usando a atribuição probabilística. Você pode especificar de 0 a 24 horas.
|
Opcional. Para links de parceiros, o padrão é configurado para cada site de aplicativo e parceiro na página Configuração de parceiros. |
Opcional. Para links personalizados, o padrão é 24 horas. |
|
view_deterministic_window |
A janela de atribuição para visualização (impressões) usando a atribuição determinística. Você pode especificar de 0 a 24 horas. |
Opcional. Para links de parceiros, o padrão é definido para cada site de aplicativo e parceiro na página Configuração de parceiros. |
Opcional. Para links personalizados, o padrão é 24 horas. |
|
view_probabilistic_window |
A janela de atribuição para visualização (impressões) usando a 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 cliques em campanhas de reengajamento. Isso só é relevante se enable_reengagement estiver definido como true. Você pode especificar de 0 a 30 dias. |
Opcional 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 de CTV. Isso só é relevante se o parceiro de rede oferecer suporte a campanhas de CTV. Dependendo do parceiro, o valor de enable_ctv pode ser verdadeiro por padrão. | Opcional | Opcional |
Exemplo de saída
{
"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 saída
Se o Singular Link tiver sido criado com êxito, a resposta incluirá os seguintes parâmetros:
| Parâmetro | Descrição |
|---|---|
| tracking_link_id | A ID interna do link de rastreamento. Ele também está incluído no URL do link de rastreamento. |
| tracking_link_name | O nome que você deu ao link de rastreamento. |
| click_tracking_link | O URL do link de rastreamento para campanhas de cliques. O URL inclui macros que serão substituídas por valores reais pela rede de parceiros quando o link for servido. |
| impression_tracking_link | O URL do link de rastreamento para campanhas de visualização, se suportado. |
| short_link |
Uma versão abreviada do URL do link (somente para links personalizados). Observação: esse link é criado usando nosso serviço de links curtos, não nosso serviço de rastreamento de referências. Esses links curtos não expiram. No exemplo acima, o link curto é "https://prod_test.sng.link/D75p1/mbm7/961w", em que "961w" é o ID do 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. |
Mensagens de erro
Se o link NÃO tiver sido criado com êxito devido a um problema de configuração, você receberá uma mensagem explicando o problema. Corrija-o e tente chamar Create Link novamente.
| Mensagem de erro | Observações |
|---|---|
| app_site_id não existe | |
| O parceiro x não está configurado para o aplicativo y | |
| link_domain não definido | |
| <attribution_window> valor não suportado | Você definiu um valor que não é compatível com uma das janelas de atribuição. |
| O parceiro não oferece suporte a vários sistemas operacionais por link | Você tentou definir os valores de redirecionamento do Android e do iOS para um parceiro de rede que não oferece suporte ao uso de um único link de rastreamento para vários sistemas operacionais. |
| O parceiro X não permite links de rastreamento | As redes de autoatribuição (SANs), como Facebook e Google, não suportam links de rastreamento e, portanto, o Singular não permite que você crie Singular Links para esses parceiros. |
Exibir ponto de extremidade de links
| GET | https://api.singular.net/api/v1/singular_links/links |
Uso
Use esse endpoint para visualizar os detalhes de seus Singular Links existentes.
Você pode filtrar a solicitação por um ou mais dos seguintes campos: app_id, app_site_id, partner_id, source_name e tracking_link_id. Para obter esses IDs, chame os pontos de extremidade Get Apps e Get Configured Partners.
Observação: esse é o mesmo ponto de extremidade (URL) que você usa para criar um novo link, mas você usa uma solicitação GET em vez de uma solicitação POST.
Exemplo 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 da consulta
| Parâmetro | Descrição |
|---|---|
| link_type | [ Opcional] Se você quiser ver apenas um tipo de link, digite "custom", "partner" ou "mobile_web_to_app". |
| partner_id | [Opcional] Se você quiser ver apenas os links de parceiros configurados para um parceiro específico, digite a ID interna singular do parceiro. |
| source_name |
[Opcional] Se você quiser ver apenas os links personalizados configurados para uma fonte específica. |
| app_id | [Opcional] Se quiser ver apenas os links configurados para um aplicativo específico, insira o ID interno Singular do aplicativo. |
| app_site_id | [Opcional] Se você quiser ver apenas os links configurados para um site de aplicativo específico, insira a ID interna Singular do site do aplicativo. |
| tracking_link_id |
[Opcional] Se você quiser ver apenas os detalhes de um Singular Link específico, digite o ID do link. Você pode encontrar o ID no URL do link de rastreamento: https://myapp.sng.link/sdfsdf/abcde?... |
Exemplo de saída
A saída contém uma matriz de todos os Singular Links que correspondem aos seus parâmetros de filtragem (se você não tiver inserido nenhum parâmetro de filtragem, isso mostrará todos os Singular Links 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 saída
Uma matriz com os seguintes parâmetros por link:
| Parâmetro | Descrição |
|---|---|
| Parâmetros gerais | |
| tracking_link_id | Um identificador exclusivo para o link de rastreamento. |
| tracking_link_name | O nome dado ao link quando ele foi criado. |
| click_tracking_link | O URL do link de rastreamento para cliques. |
| impression_tracking_link | O URL do link de rastreamento para visualização. |
| created_utc | Registro de data e hora UTC de quando o link foi criado. |
| modified_utc | Carimbo de data e hora UTC de quando o link foi modificado pela última vez. |
| link_type | "partner" ou "custom" |
| partner_id | A ID interna única e singular do parceiro. |
| app_id | A ID interna Singular do aplicativo. |
| Destinos do link | |
| android_redirection |
Um objeto que contém os seguintes parâmetros:
|
| ios_redirection |
Um objeto que contém os seguintes parâmetros:
|
| destination_fallback_url | Esse é 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 aplicativo, você deseja que o link direto o envie para uma tela específica dentro do aplicativo. Mas se o usuário ainda não tiver o aplicativo instalado, você deseja redirecioná-lo para a loja de aplicativos para fazer o download do seu aplicativo. |
| Funcionalidade opcional | |
| enable_reengagement | True se o link foi marcado como um link usado para campanhas de reengajamento/retargeting. |
| enabled_ctv | True se o link for compatível com campanhas de CTV. |
| Configurações da janela de atribuição | |
| click_deterministic_window | A janela de atribuição para esse link em campanhas de cliques quando atribuído por meio de métodos determinísticos (por exemplo, correspondência da ID do dispositivo usada para o clique com a ID do dispositivo usada para instalar o aplicativo) |
| click_probabilistic_window | A janela de atribuição para esse link em campanhas de cliques quando atribuído por meio de métodos probabilísticos (como o local do dispositivo, o sistema operacional etc.) |
| view_deterministic_window | A janela de atribuição para esse link em campanhas de visualização quando atribuído por meio de métodos determinísticos (por exemplo, correspondência da ID do dispositivo usada para o clique com a ID do dispositivo usada para instalar o aplicativo) |
| view_probabilistic_window | A janela de atribuição para esse link em campanhas de exibição quando atribuído por meio de métodos probabilísticos (como o local do dispositivo, o sistema operacional etc.) |
| click_reengagement_window | A janela de atribuição para esse link em campanhas de reengajamento por meio de cliques. Esse parâmetro é incluído somente se o reengajamento estiver ativado para esse Singular Link. |
Ponto de extremidade Get Apps
| GET | https://api.singular.net/api/v1/singular_links/apps |
Uso
Use esse endpoint para obter uma lista de todos os seus sites de aplicativos configurados no Singular (consulte Qual é a diferença entre um aplicativo e um site de aplicativo?
Exemplo 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>'Exemplo de saída
{
'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 saída
A resposta é uma matriz de site de aplicativo com os seguintes parâmetros para cada site de aplicativo:
| Parâmetro | Descrição |
|---|---|
| app_site_id | ID interna da Singular para o site de aplicativos (ID do aplicativo + SO + pacote) (consulte Qual é a diferença entre um aplicativo e um site de aplicativos? |
| app_platform | A plataforma definida para o site de aplicativos, por exemplo, iOS. |
| app_store_url | O URL do aplicativo no Google Play ou na Apple App Store. |
| site_public_id | Esse é o ID do aplicativo na Apple App Store ou no Google Play (consulte Qual é a diferença entre um aplicativo e um site de aplicativos? Para sites, esse é o URL do site. |
| app_bundle_id | O identificador interno do aplicativo, por exemplo, "com.myapp". |
| app_id | O ID interno da Singular para o aplicativo na Singular. |
| app | O nome do aplicativo conforme configurado na página Aplicativos . |
Ponto de extremidade Obter parceiros configurados
| GET | https://api.singular.net/api/v1/singular_links/configured_partners |
Uso
Recupera uma lista dos parceiros (redes de anúncios) que você configurou para cada site de aplicativo. Você pode filtrar a solicitação para sites de aplicativos e parceiros específicos.
Observação: a lista não incluirá parceiros como Facebook, Google Ads ou outras redes de auto-atribuição (SANs) que não oferecem suporte a Links Singulares.
Exemplo 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 da consulta
| Parâmetro | Descrição |
|---|---|
| app_site_id | [Opcional] Uma ID do site do aplicativo ou uma lista de IDs do site do aplicativo separadas por vírgulas, para filtrar a lista. |
| partner_id | [Opcional] Uma ID de parceiro ou uma lista de IDs de parceiro separadas por vírgulas, para filtrar a lista. |
Exemplo de saída
A seguir, um exemplo de saída de uma solicitação filtrada por app_site_id = "22334". Há dois parceiros configurados para esse site de aplicativo.
{
'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 saída
Uma matriz de sites de aplicativos com os seguintes parâmetros por site de aplicativo::
| Parâmetro | Descrição |
|---|---|
| app_site_id | ID interna da Singular para o site de aplicativos. |
| app_id | ID interna da Singular para o aplicativo. |
| singular_partner_display_name | O nome do parceiro na Singular, por exemplo, "IronSource". |
| singular_partner_id | ID interna da Singular para o parceiro. |
Ponto de extremidade Obter todos os parceiros
| GET | https://api.singular.net/api/v1/singular_links/all_partners |
Uso
Recupera detalhes sobre os parceiros configurados para sua organização.
Você pode filtrar a solicitação por um ID de parceiro ou por vários IDs de parceiro para obter detalhes apenas sobre parceiros específicos.
Observação: a lista não incluirá parceiros como Facebook, Google Ads ou outras redes de auto-atribuição (SANs) que não suportam Singular Links.
Exemplo 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 da consulta
| Parâmetro | Descrição |
|---|---|
| singular_partner_id | [Opcional] Lista separada por vírgulas de IDs de parceiros para exibir detalhes. |
Exemplo de saída
{
'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 saída
Uma matriz de parceiros com os seguintes parâmetros por parceiro:
| Parâmetro | Descrição |
|---|---|
| singular_partner_id | ID interna da Singular para o parceiro. |
| singular_partner_display_name | O nome do parceiro na Singular, por exemplo, "IronSource". |
| support_multiple_os | True (Verdadeiro) se o parceiro suportar a definição de um destino iOS e um destino Android no mesmo link de rastreamento. Se o parceiro oferecer suporte, você poderá criar um Singular Link para ser usado em campanhas para ambos os sistemas operacionais. |
| support_reengagement | Verdadeiro se o parceiro oferecer suporte a links de reengajamento. Se suportado pelo parceiro, você poderá criar um Singular Link marcado como um link de reengajamento e usá-lo em sua campanha de retargeting. |
| support_ctv | Verdadeiro se o parceiro oferecer suporte a CTV. Se for compatível com o parceiro, você poderá criar links habilitados para CTV. |
Ponto de extremidade Get Link Domains
| GET | https://api.singular.net/api/v1/singular_links/domains |
Uso
Recupera uma lista de seus domínios de links singulares. Os links de rastreamento Singular têm a seguinte estrutura, em que [SUBDOMAIN] é escolhido por você e a zona DNS é "sng.link":
https://[SUBDOMAIN].sng.link/[PARAMETERS]
Ao criar um link Singular, você precisa especificar o subdomínio e a zona DNS a serem usados no URL do link.
Dica: Os domínios de links são criados na plataforma Singular em Atribuição > Gerenciar links. Você precisa definir pelo menos um domínio antes de poder criar qualquer Singular Links.
Exemplo 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>'Exemplo de saída
Essa solicitação retorna uma lista dos domínios Singular Links criados para sua organização.
{
'available_domains': [
{
'subdomain': 'myorg',
'dns_zone': 'sng.link'
},
{
'subdomain': 'awesomeapp',
'dns_zone': 'sng.link'
}
]
}Parâmetros de saída
| Parâmetro | Descrição |
|---|---|
| subdomínio | O nome que você deu ao subdomínio, por exemplo, o nome da sua empresa. Juntamente com dns_zone, ele cria o domínio a ser usado em Singular Links. |
| dns_zone | "sng.link" |