API de eventos #
(a utilizar para enviar eventos de «Primeira abertura da aplicação» e «Abertura da aplicação»)
Autenticação:
Autentificamos todos os pedidos enviados ao servidor Tenjin utilizando a chave do SDK do Tenjin
- como parâmetro «api_key» no URL do pedido, ou
- utilizando o nome de utilizador e deixando o campo da palavra-passe em branco na autenticação de acesso básica
URL POST ou GET:
https://track.tenjin.com/v0/event
Uma resposta do tipo {“code”:200} indica que o pedido foi bem-sucedido.
Parâmetros:
*: obrigatório
| Parâmetro | Tipo | Descrição | Exemplo |
api_key* | String | Chave SDK Tenjin gerada para cada aplicação. Pode encontrá-la na página da aplicação. Se, em vez disso, utilizar a autenticação básica, este parâmetro não é necessário. | ENECCCVB8UQVLPSQ58S8EZXTJHA7FHDW |
analytics_installation_id* | UUID | O Tenjin gerou um identificador específico para a instalação da aplicação.Disponível através de callbacks S2S ou do SDK (SDK Android,SDK iOS,SDK Unity) | 29eeb1610fe74997b6d53f02e9711f8c |
advertising_id* | String | O ID de publicidade bruto do dispositivo. No caso dos utilizadores que optaram por não participar, pode estar vazio ou conter apenas zeros. | f024e65f3dd94f16983726bcef192d68 |
developer_device_id (*obrigatório para iOS) | String | O identificador do fornecedor | b6bc48fe0ce949e4b229ce6c55663fca |
bundle_id* | String | ID do pacote da aplicação. | com.tenjin.wordfinder |
platform* | String | ios, android, amazon, android_other | iOS |
limit_ad_tracking | String | 1 para «sim», 0 para «não». | 1 |
os_version* | String | Para Android: String os_version = String.valueOf(Build.VERSION.SDK_INT) Para iOS: [[UIDevice currentDevice] systemVersion] | 8.0 |
app_version | Float, Decimal | A versão da sua aplicação Para Android: String app_version = context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionName + “.” + context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionCode) Para iOS: [[[NSBundle mainBundle] infoDictionary] objectForKey:@”CFBundleShortVersionString”] | 1.0.3 |
sdk_version* | String | server | server |
country | String | A norma ISO relativa aos códigos de país das configurações regionais (ver, por exemplo, documentação da Apple). | EUA |
ip_address | String | O endereço IP do utilizador. Este é utilizado para identificar o país. Se este parâmetro não estiver presente, utilizaremos o IP do cabeçalho HTTP. | 71.165.85.114 |
ad_user_data | Booleano | Parâmetro «Google User Consent Signal»: consentimento para a transmissão por terceiros de dados ao nível do utilizador para anúncios — 1 para consentimento concedido, 0 para consentimento recusado. Remova completamente o parâmetro da solicitação (não deixe em branco) quando não houver dados relativos ao consentimento do utilizador. | 1 |
ad_personalization | Booleano | Parâmetro «Google User Consent Signal»: «consent» para anúncios personalizados¹; «0» para consentimento concedido; «0» para consentimento recusado. Remova completamente o parâmetro da solicitação (não deixe em branco) quando não houver dados relativos ao consentimento do utilizador | 1 |
referrer | String | Dados recolhidos relativos às instalações Android monitorizadas | campaign_id%3D |
os_version_release (*obrigatório para monitorizar o Google Ads) | String | Para Android: String os_version_release = String.valueOf(Build.VERSION.RELEASE) Para iOS: [[UIDevice currentDevice] systemVersion] | 8.0.1 |
build_id (*obrigatório para monitorizar o Google Ads) | String | Para Android: String build = String.valueOf(Build.ID) Para iOS: @import Darwin.sys.sysctl; NSString *build(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname(“kern.osversion”, buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding];} | UP1B.231005.007 |
locale (*obrigatório para monitorizar o Google Ads) | String | Para Android: String locale = Locale.getDefault().toString() Para iOS: [[NSLocale currentLocale] localeIdentifier] | es_AR |
device_model (*obrigatório para monitorizar o Google Ads) | String | Para Android: String device = Build.MODEL; Para iOS: @import Darwin.sys.sysctl; NSString *device(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname(“hw.machine”, buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding];} | SM-F731A |
odm_info | String | Esta é a sequência necessária para executar a atribuição probabilística através do Google Ads para o iOS. Terá de a obter primeiro a partir do SDK do ODM. | AB7Dr_EJBWQ_lT_l1V0z5xqDB9MnLGbINV5r2w1jhVTITlm0IK7QE16Bf2sIjI_twjeMoQl3SedWsZiPtijTZ2DkUYI_H9RI6lkStqbwmBVsnu_QH4hfkuJeMwhFEzBEJCz3a8cdD2U1MRd1jwn2b_hbaHsbVO3NlE0xsExo5HtcuWmsaMdddKn9vFRPtyPQvSLjSl4AlsdyAaYg9Hw-FyYfm9eAbqrxy3NXkZtjJeXRThMG6MTNJA |
customer_user_id | String | ID de utilizador personalizado para o evento | jdabGcerT32_d |
API de compras #
(a utilizar para enviar eventos de compra)
Autenticação:
Autentificamos todos os pedidos enviados ao servidor Tenjin utilizando a chave do SDK do Tenjin
- como parâmetro «api_key» no URL do pedido, ou
- utilizando o nome de utilizador e deixando o campo da palavra-passe em branco na autenticação de acesso básica
URL POST ou GET:
https://track.tenjin.com/v0/purchase
Parâmetros:
*: obrigatório
| Parâmetro | Tipo | Descrição | Exemplo |
api_key* | String | Chave SDK Tenjin gerada para cada aplicação. Pode encontrá-la na página da aplicação. Se, em vez disso, utilizar a autenticação básica, este parâmetro não é necessário. | ENECCCVB8UQVLPSQ58S8EZXTJHA7FHDW |
analytics_installation_id* | UUID | A Tenjin gerou um identificador específico para a instalação da aplicação. Disponível através de S2S Callbacks ou do SDK.SDK Android,SDK iOS,SDK Unity | 29eeb1610fe74997b6d53f02e9711f8c |
advertising_id* | String | O ID de publicidade bruto do dispositivo. No caso dos utilizadores que optaram por não participar, pode estar vazio ou conter apenas zeros. | f024e65f3dd94f16983726bcef192d68 |
developer_device_id (*obrigatório para iOS) | String | O identificador do fornecedor | b6bc48fe0ce949e4b229ce6c55663fca |
bundle_id* | String | ID do pacote da aplicação. | com.tenjin.wordfinder |
platform* | String | ios, android, amazon, android_other | iOS |
limit_ad_tracking | String | 1 para «sim», 0 para «não». | 1 |
os_version* | String | Para Android: String.valueOf(Build.VERSION.SDK_INT) Para iOS: [[UIDevice currentDevice] systemVersion] | 8.0 |
app_version (*obrigatório para monitorizar o Google Ads) | Float, Decimal | A versão da sua aplicação Para Android: String app_version = context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionName + “.” + context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionCode) Para iOS: [[[NSBundle mainBundle] infoDictionary] objectForKey:@”CFBundleShortVersionString”] | 1.0.3 |
sdk_version* | String | server | server |
ip_address | String | O endereço IP do utilizador. Este é utilizado para identificar o país, de acordo com os parâmetros de consentimento do utilizador da Google DMA. Se este parâmetro não estiver presente, utilizaremos o endereço IP do cabeçalho HTTP. | 71.165.85.114 |
ad_user_data | Booleano | Parâmetro «Google User Consent Signal»: consentimento para a transmissão por terceiros de dados ao nível do utilizador para anúncios — 1 para consentimento concedido, 0 para consentimento recusado. Remova completamente o parâmetro da solicitação (não deixe em branco) quando não houver dados relativos ao consentimento do utilizador. | 1 |
ad_personalization | Booleano | Parâmetro «Google User Consent Signal»: «consent» para anúncios personalizados¹; «0» para consentimento concedido; «0» para consentimento recusado. Remova completamente o parâmetro da solicitação (não deixe em branco) quando não houver dados relativos ao consentimento do utilizador | 1 |
postcut | String | 1 para o envio das compras após a dedução da plataforma | 1 |
product_id* | String | Nome exclusivo do produto adquirido. | loja_de_moedas |
price* | Float, Decimal | O preço unitário do artigo adquirido na moeda padrão (por exemplo, o USD é apresentado em dólares). | 0.99 |
quantity* | Número inteiro | O número de unidades adquiridas. | 1 |
country | String | A norma ISO relativa aos códigos de país das configurações regionais (ver, por exemplo, documentação da Apple). | EUA |
currency* | String | Os códigos de moeda ISO utilizados pela Apple e pela Google (ver, por exemplo, documentação da Apple). | USD |
os_version_release (*obrigatório para monitorizar o Google Ads) | String | Para Android: String os_version_release = String.valueOf(Build.VERSION.RELEASE) Para iOS: [[UIDevice currentDevice] systemVersion] | 14 |
build_id (*obrigatório para monitorizar o Google Ads) | String | Para Android: String build = String.valueOf(Build.ID) Para iOS: @import Darwin.sys.sysctl; NSString *build(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname(“kern.osversion”, buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding];} | UP1B.231005.007 |
locale (*obrigatório para monitorizar o Google Ads) | String | Para Android: String locale = Locale.getDefault().toString() Para iOS: [[NSLocale currentLocale] localeIdentifier] | es_AR |
device_model (*obrigatório para monitorizar o Google Ads) | String | Para Android: String device = Build.MODEL; Para iOS: @import Darwin.sys.sysctl; NSString *device(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname(“hw.machine”, buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding];} | SM-F731A |
customer_user_id | String | ID de utilizador personalizado para o evento | jdabGcerT32_d |
tracking_status(Obrigatório para a execução de campanhas Meta AEM no iOS) | String | número inteiro para o dispositivo iOS Estado da ATT. 0 => não determinado, 1 => restrito, 2 => indeferido, 3 => autorizado2 | 2 |
Se não tiver um recibo ou uma assinatura válidos, não inclua de todo os parâmetros no URL do pedido. Ainda assim, podemos apresentar a compra sem recibo nem assinatura através do S2S no painel de controlo.
API de eventos personalizados #
(a utilizar para enviar todos os eventos personalizados)
Autenticação:
Autentificamos todos os pedidos enviados ao servidor Tenjin utilizando a chave do SDK do Tenjin
- como parâmetro «api_key» no URL do pedido, ou
- utilizando o nome de utilizador e deixando o campo da palavra-passe em branco na autenticação de acesso básica
URL POST ou GET:
https://track.tenjin.com/v0/event
Parâmetros:
*: obrigatório
| Parâmetro | Tipo | Descrição | Exemplo |
api_key* | String | Chave SDK Tenjin gerada para cada aplicação. Pode encontrá-la na página da aplicação. Se, em vez disso, utilizar a autenticação básica, este parâmetro não é necessário. | ENECCCVB8UQVLPSQ58S8EZXTJHA7FHDW |
analytics_installation_id* | UUID | A Tenjin gerou um identificador específico para a instalação de aplicações. Disponível através de callbacks S2S ou do SDK.SDK Android,SDK iOS,SDK Unity | 29eeb1610fe74997b6d53f02e9711f8c |
advertising_id* | String | O ID de publicidade bruto do dispositivo. No caso dos utilizadores que optaram por não participar, pode estar vazio ou conter apenas zeros. | f024e65f3dd94f16983726bcef192d68 |
developer_device_id (*obrigatório para iOS) | String | O identificador do fornecedor | b6bc48fe0ce949e4b229ce6c55663fca |
bundle_id* | String | ID do pacote da aplicação. | com.tenjin.wordfinder |
platform* | String | ios, android, amazon, android_other | iOS |
limit_ad_tracking | String | 1 para «sim», 0 para «não». | 1 |
os_version* | String | Para Android: String.valueOf(Build.VERSION.SDK_INT) Para iOS: [[UIDevice currentDevice] systemVersion] | 8.0 |
app_version (* obrigatório para o Google Ads) | Float, Decimal | A versão da sua aplicação Para Android: String app_version = context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionName + “.” + context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionCode) Para iOS: [[[NSBundle mainBundle] infoDictionary] objectForKey:@”CFBundleShortVersionString”] | 1.0.3 |
sdk_version* | String | server | server |
ip_address | String | O endereço IP do utilizador. Este é utilizado para identificar o país. Se este parâmetro não estiver presente, utilizaremos o IP do cabeçalho HTTP. | 71.165.85.114 |
ad_user_data | Booleano | Parâmetro «Google User Consent Signal»: consentimento para a transmissão por terceiros de dados ao nível do utilizador para anúncios — 1 para consentimento concedido, 0 para consentimento recusado. Remova completamente o parâmetro da solicitação (não deixe em branco) quando não houver dados relativos ao consentimento do utilizador. | 1 |
ad_personalization | Booleano | Parâmetro «Google User Consent Signal»: «consent» para anúncios personalizados¹; «0» para consentimento concedido; «0» para consentimento recusado. Remova completamente o parâmetro da solicitação (não deixe em branco) quando não houver dados relativos ao consentimento do utilizador | 1 |
event* | String | Este é o nome do evento – nome do evento (por exemplo, “tutorial_complete”, “registration_complete” ou “level_1_complete”) | evento_concluído |
value | Nulo, Inteiro | Valor associado ao nome do evento (acima). Pode ser utilizado para calcular valores relacionados com o nome de um evento. (por exemplo, se pretender calcular a quantidade de moeda virtual para um evento específico). | 10 |
os_version_release (*obrigatório para o Google Ads) | String | Para Android: String os_version_release = String.valueOf(Build.VERSION.RELEASE) Para iOS: [[UIDevice currentDevice] systemVersion] | 14 |
build_id (*obrigatório para o Google Ads) | String | Para Android: String build = String.valueOf(Build.ID) Para iOS: @import Darwin.sys.sysctl; NSString *build(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname(“kern.osversion”, buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding];} | UP1B.231005.007 |
locale (*obrigatório para o Google Ads) | String | Para Android: String locale = Locale.getDefault().toString() Para iOS: [[NSLocale currentLocale] localeIdentifier] | es_AR |
device_model (*obrigatório para o Google Ads) | String | Para Android: String device = Build.MODEL; Para iOS: @import Darwin.sys.sysctl; NSString *device(void) { size_t bufferSize = 64; NSMutableData *buffer = [[NSMutableData alloc] initWithLength:bufferSize]; int status = sysctlbyname(“hw.machine”, buffer.mutableBytes, &bufferSize, NULL, 0); if (status != 0) { return nil; } return [[NSString alloc] initWithCString:buffer.mutableBytes encoding:NSUTF8StringEncoding];} | SM-F731A |
customer_user_id | String | ID de utilizador personalizado para o evento | jdabGcerT32_d |
tracking_status(Obrigatório para a execução de campanhas Meta AEM no iOS) | String | número inteiro para o dispositivo iOS Estado da ATT. 0 => não determinado, 1 => restrito, 2 => indeferido, 3 => autorizado | 2 |