Pular para o conteúdo principal

​
Visão geral do MACT

A mensuração de promoção de apps para dispositivos móveis da X permite que anunciantes acompanhem o sucesso de campanhas na X projetadas para gerar instalações ou outras conversões no app. Um parceiro de mensuração móvel da X permite ao anunciante definir quais conversões deseja acompanhar nos apps que está promovendo na X. Depois que o anunciante define o tipo e as janelas de tempo dos eventos que deseja acompanhar, o parceiro de mensuração móvel enviará todos esses eventos para a X e receberá imediatamente dados de atribuição indicando a campanha e o criativo com o qual o usuário interagiu para gerar a conversão.

​
Eventos de conversão

Para relatar um evento de conversão ao X e obter dados de atribuição, o parceiro deve enviar o id do app móvel, o type e o carimbo de data/hora da conversão, bem como um valor com hash do id de publicidade/dispositivo. O envio desses dados registrará o evento de conversão na plataforma do X e retornará a atribuição quando apropriado. Além disso, o anunciante pode optar por fornecer metadata extra sobre o evento de conversão, como o valor de uma compra, o id de um produto ou um método de registro.

​
Referência da API

​
Evento de conversão

​
POST conversion_event

Registre um evento de conversão de mensuração em dispositivos móveis. A resposta indicará a atribuição do X ou do X Audience Platform (TAP). Isso está relacionado ao endpoint GET conversion_attribution. X, TAP ou nenhuma atribuição poderá ser indicado na resposta. O nó twitter_attribution sempre estará presente e terá o valor null quando não houver atribuição do X (veja o exemplo de resposta abaixo). Se houver atribuição do TAP, um nó tpn_attribution estará presente e preenchido conforme apropriado. Consulte a visão geral do TAP para mais informações. Há vários parâmetros opcionais disponíveis para definir os metadados associados a cada evento de conversão. Esses metadados não afetam os cálculos de atribuição.
URL do recurso
https://ads-api.x.com/12/conversion_event
Parâmetros
NomeDescrição
app_id
obrigatório		O identificador exclusivo na respectiva loja de apps.

Type: int, string

Exemplo: 333903271, com.vine.android
conversion_time
obrigatório		O horário do evento de conversão no formato de timestamp ISO-8601, com milissegundos.

Type: string

Exemplo: 2014-05-22T02:38:28.103Z
conversion_type
obrigatório		O tipo de evento de conversão.

Type: enum

Valores possíveis: PURCHASE, SIGN_UP, INSTALL, RE_ENGAGE, UPDATE, TUTORIAL_COMPLETE, RESERVATION, ADD_TO_CART, ADD_TO_WISHLIST, LOGIN, CHECKOUT_INITIATED, SEARCH, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, CONTENT_VIEW, SHARE, INVITE, ADDED_PAYMENT_INFO, SPENT_CREDITS, RATED
hashed_device_id
obrigatório		O IDFA ou AdID com hash HMAC_SHA-256.

Type: string

Exemplo: ABCD1234XYZ
os_type
obrigatório		O tipo de SO do App.

Type: enum

Valores possíveis: IOS, ANDROID
click_window
opcional		A janela de clique para este evento, em dias.

Type: int

Observação: click_window deve ser maior ou igual a view_through_window

Padrão: 14
Valores possíveis: 1, 7, 14, 30
device_ip_address
opcional		Endereço IPv4 ou IPv6 do dispositivo quando ocorreu o evento de conversão.

Type: string

Exemplo: 192.133.78.1
level
opcional		Um nível associado a este evento.

Type: int

Exemplo: 2
non_twitter_engagement_time
opcional		O horário do último engajamento fora do X antes da conversão.

Type: string

Exemplo: 2014-05-22T02:38:28.103Z
non_twitter_engagement_type
opcional		O tipo de engajamento fora do X anterior ao evento de conversão.

Type: enum

Valores possíveis: CLICK, VIEW
number_items
opcional		Número de itens associados a este evento.

Type: int

Exemplo: 2
price_currency
opcional		Espera-se um código ISO 4217 para indicar a moeda associada a este evento.

Type: String

Exemplos: EUR, USD, JPY
price_micro
opcional		Um valor de preço associado a este evento em micros.

Type: int

Exemplo: 123450000
user_payment_info
opcional		Um valor booleano que indica se as informações de pagamento do usuário estão armazenadas no App associado a este evento.

Type: bool

Valores possíveis: true ou false
view_through_window
opcional		A janela de visualização para este evento, em dias.

Observação:

click_window deve ser maior ou igual a view_through_window.

Type: int

Padrão: 1
Valores possíveis: 0, 1, 7, 14, 30
Exemplo de requisição
https://ads-api.x.com/12/conversion_event?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=1
Exemplo de resposta
    {
      "data": {
        "conversion_value_micro": 0,
        "view_through_window": 1,
        "tpn_attribution": null,
        "conversion_time": "2017-01-21T01:14:00.602Z",
        "click_window": 30,
        "limit_ad_tracking": false,
        "event_metadata": null,
        "non_twitter_engagement_type": null,
        "conversion_type": "INSTALL",
        "partner_client_id": "com.appname contact id",
        "app_id": "com.appname",
        "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
        "twitter_attribution": {
          "country_code": "US",
          "engagement_time": "2017-01-21T01:13:00.602Z",
          "engagement_type": "CLICK",
          "attribution_type": "PROMOTED",
          "promoted_properties": {
            "campaign_id": "4ns44",
            "line_item_id": "3x44d",
            "publisher_app_id": "333903271"
            "account_id":"18ce11e3egb",
            "line_item_objective": "APP_INSTALLS",
            "campaign_name": null
          },
          "tweet_id": "11434635565377600"
        },
        "os_type": "ANDROID",
        "non_twitter_engagement_time": null
      },
      "request": {
        "params": {
          "version_number": "1",
          "app_id": "com.appname",
          "conversion_type": "INSTALL",
          "os_type": "ANDROID",
          "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
          "conversion_time": "2017-01-21T01:14:00.602Z",
          "click_window": "30",
          "view_through_window": "1",
          "limit_ad_tracking": "false"
        }
      }
    }

​
Tags de eventos do App

​
GET accounts/:account_id/app_event_tags

Recupere detalhes de algumas ou de todas as tags de evento de App associadas à conta atual. São elas que definem as janelas de conversão configuradas para cada tipo de conversão no Rastreamento de Conversões de App para dispositivos móveis.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, exceto em GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_event_tag_ids
opcional		Restrinja a resposta apenas às app event tags desejadas especificando uma lista de identificadores separados por vírgula. Até 200 IDs podem ser informados.

Type: string

Example: jhp
count
opcional		Especifica a quantidade de registros a tentar recuperar por solicitação.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
opcional		Especifica um cursor para obter a próxima página de resultados. Consulte Pagination para mais informações.

Type: string

Example: 8x7v00oow
sort_by
opcional		Ordena por um atributo compatível em ordem ascendente ou descendente. Consulte Sorting para mais informações.

Type: string

Example: created_at-asc
with_deleted
opcional		Inclui resultados excluídos na solicitação.

Type: boolean

Default: false
Possible values: true, false
with_total_count
opcional		Inclui o atributo de resposta total_count.

Observação: Este parâmetro e cursor são mutuamente exclusivos.

Observação: Solicitações que incluem total_count terão limites de requisições menores, atualmente definidos em 200 por 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Exemplo de requisição
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp
Exemplo de resposta
    {
      "request": {
        "params": {
          "app_event_tag_ids": [
            "jhp"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "provider_app_event_name": null,
          "app_store_identifier": "co.vine.android",
          "post_view_attribution_window": 1,
          "deep_link_scheme": "vine://",
          "id": "jhp",
          "retargeting_enabled": true,
          "conversion_type": "INSTALL",
          "created_at": "2016-12-08T07:49:58Z",
          "post_engagement_attribution_window": 14,
          "provider_app_event_id": null,
          "last_tracked_at": "2021-05-22T17:00:04Z",
          "status": "TRACKING",
          "updated_at": "2016-12-08T23:07:54Z",
          "os_type": "ANDROID",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/app_event_tags/:app_event_tag_id

Recupera uma tag de evento de App específica associada à conta atual. Elas definem as janelas de conversão configuradas para cada tipo de conversão no Rastreamento de Conversões de App para dispositivos móveis.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta alavancada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, com exceção de GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_event_tag_id
obrigatório		Uma referência à tag de evento do App com a qual você está operando na solicitação.

Type: string

Example: jhp
with_deleted
opcional		Incluir resultados excluídos na solicitação.

Type: boolean

Default: false
Possible values: true, false

​
Exemplo de requisição

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp

​
Exemplo de resposta

    {
      "request": {
        "params": {
          "app_event_tag_id": "jhp",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "provider_app_event_name": null,
        "app_store_identifier": "co.vine.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "vine://",
        "id": "jhp",
        "retargeting_enabled": true,
        "conversion_type": "INSTALL",
        "created_at": "2016-12-08T07:49:58Z",
        "post_engagement_attribution_window": 14,
        "provider_app_event_id": null,
        "last_tracked_at": "2021-05-22T17:00:04Z",
        "status": "TRACKING",
        "updated_at": "2016-12-08T23:07:54Z",
        "os_type": "ANDROID",
        "deleted": false
      }
    }

​
POST accounts/:account_id/app_event_tags

Crie uma nova tag de evento de App associada à conta atual.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, exceto GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_store_identifier
obrigatório		O identificador da loja de apps.

Type: string

Example: com.twitter.android
conversion_type
obrigatório		O tipo de evento de conversão.

Type: enum

Possible values: ACHIEVEMENT_UNLOCKED, ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, INSTALL, INVITE, LEVEL_ACHIEVED, LOGIN, PURCHASE, RATED, RESERVATION, RE_ENGAGE, SEARCH, SHARE, SIGN_UP, SPENT_CREDITS, TUTORIAL_COMPLETE, UPDATE
os_type
obrigatório		O tipo de sistema operacional (OS) do app.

Type: enum

Possible values: IOS, ANDROID
provider_app_event_id
obrigatório		O id da tag de conversão no site do provedor.

Type: string

Example: provider_tag_j5394
provider_app_event_name
obrigatório		O nome da tag de conversão no site do provedor.

Type: string

Example: provider_name_a4382
deep_link_scheme
opcional		Especifique o URI de deep link do app associado a esta tag.

Type: string

Example: twitter://
post_engagement_attribution_window
opcional		A janela de atribuição pós-engajamento para esses eventos.

Type: int

Default: 30
Possible values: 1, 7, 14, 30
post_view_attribution_window
opcional		A janela de atribuição pós-visualização para esses eventos.

Type: int

Default: 1
Possible values: 0, 1, 7, 14, 30
retargeting_enabled
opcional		Especifique se o retargeting deve ser ativado para esta tag de evento de app.

Type: boolean

Default: true
Possible values: true, false
Exemplo de requisição
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_store_identifier=com.twitter.android&os_type=ANDROID&conversion_type=PURCHASE&provider_app_event_id=abc123&provider_app_event_name=test-tag
Exemplo de resposta
    {
      "data": {
        "provider_app_event_name": "tag-de-teste",
        "app_store_identifier": "com.twitter.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "https://",
        "id": "3p3t",
        "retargeting_enabled": true,
        "conversion_type": "PURCHASE",
        "created_at": "2017-09-06T06:58:22Z",
        "post_engagement_attribution_window": 30,
        "provider_app_event_id": "abc123",
        "updated_at": "2017-09-06T06:58:22Z",
        "os_type": "ANDROID",
        "deleted": false
      },
      "request": {
        "params": {
          "provider_app_event_name": "tag-de-teste",
          "app_store_identifier": "com.twitter.android",
          "account_id": "18ce54d4x5t",
          "conversion_type": "PURCHASE",
          "provider_app_event_id": "abc123",
          "os_type": "ANDROID"
        }
      }
    }

​
DELETE accounts/:account_id/app_event_tags/:id

Exclui a tag de evento da App especificada pertencente à conta atual.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, com exceção de GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
id
obrigatório		Uma referência à tag de evento de app com a qual você está operando na solicitação.

Type: string

Example: jhp
Exemplo de requisição
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Exemplo de resposta
    {
      "data": {
        "provider_app_event_name": null,
        "app_store_identifier": "co.vine.android",
        "post_view_attribution_window": 1,
        "deep_link_scheme": "vine://",
        "id": "jhp",
        "retargeting_enabled": true,
        "conversion_type": "INSTALL",
        "created_at": "2016-12-08T07:49:58Z",
        "post_engagement_attribution_window": 14,
        "provider_app_event_id": null,
        "last_tracked_at": "2021-05-22T17:00:04Z",
        "status": "TRACKING",
        "updated_at": "2017-08-30T05:44:57Z",
        "os_type": "ANDROID"
        "deleted": true
      },
      "request": {
        "params": {
          "id": "jhp",
          "account_id": "5gvk9h"
        }
      }
    }

​
Listas de Apps

​
GET accounts/:account_id/app_lists

Recupera detalhes de algumas ou de todas as listas de apps associadas à conta atual.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists

​
Parâmetros

NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, com exceção de GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_list_ids
opcional		Restringe a resposta apenas às listas de apps desejadas especificando uma lista de identificadores separados por vírgula. Até 200 IDs podem ser fornecidos.

Type: string

Example: wm7x
count
opcional		Especifica o número de registros a tentar recuperar por solicitação.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
opcional		Especifica um cursor para obter a próxima página de resultados. Consulte Paginação para mais informações.

Type: string

Example: 8x7v00oow
sort_by
opcional		Ordena por um atributo compatível em ordem ascendente ou descendente. Consulte Ordenação para mais informações.

Type: string

Example: created_at-asc
with_deleted
opcional		Inclui resultados excluídos na solicitação.

Type: boolean

Default: false
Possible values: true, false
with_total_count
opcional		Inclui o atributo de resposta total_count.

Observação: Este parâmetro e cursor são mutuamente exclusivos.

Observação: Solicitações que incluem total_count terão limites de requisições menores, atualmente definidos em 200 por 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Exemplo de requisição
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x
Exemplo de resposta
    {
      "request": {
        "params": {
          "app_list_ids": [
            "wm7x"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "id": "wm7x",
          "name": "foo @ 14026528192426843"
        }
      ]
    }

​
GET accounts/:account_id/app_lists/:app_list_id

Recupere uma lista de apps específica associada à conta atual.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, exceto em GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_list_id
obrigatório		Referência à lista de Apps com a qual você está trabalhando na solicitação.

Type: string

Example: 28ukf
with_deleted
opcional		Incluir resultados excluídos na solicitação.

Type: boolean

Default: false
Possible values: true, false
Exemplo de requisição
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Exemplo de resposta
    {
      "data": {
        "name": "twitter @ 262689209670784",
        "id": "28ukf",
        "created_at": "2017-08-17T17:07:42Z",
        "updated_at": "2017-08-17T17:07:42Z",
        "deleted": false,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_list_id": "28ukf",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
POST accounts/:account_id/app_lists

Cria um app_list associado à conta atual. Atualmente, há um limite de 100 objetos app_list por account_id e de 500 Apps por app_list.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, com exceção de GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_store_identifiers
obrigatório		Os identificadores da loja de apps a serem incluídos em app_list

Type: string

Example: com.twitter.android
name
obrigatório		O nome que você atribuirá a app_list

Type: string

Example: My First App List
Exemplo de requisição
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android
Exemplo de resposta
    {
      "data": {
        "name": "Lista de Apps",
        "id": "2a4um",
        "created_at": "2017-09-06T07:17:26Z",
        "updated_at": "2017-09-06T07:17:26Z",
        "deleted": false,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android",
          }
        ]
      },
      "request": {
        "params": {
          "app_store_identifiers": [
            "com.twitter.android"
          ],
          "name": "Lista de Apps",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
DELETE accounts/:account_id/app_lists/:app_list_id

Exclui a app list especificada associada à conta atual.
URL do recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta alavancada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, exceto GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
app_list_id
obrigatório		Uma referência à App List com a qual você está operando na solicitação.

Type: string

Example: 28ukf
Exemplo de requisição
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Exemplo de resposta
    {
      "data": {
        "name": "twitter @ 262689209670784",
        "id": "28ukf",
        "created_at": "2017-08-17T17:07:42Z",
        "updated_at": "2017-09-12T22:20:33Z",
        "deleted": true,
        "apps": [
          {
            "app_store_identifier": "com.twitter.android",
            "os_type": "Android"
          }
        ]
      },
      "request": {
        "params": {
          "app_list_id": "28ukf",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
Configurações do provedor de eventos do App

❯

​
GET accounts/:account_id/app_event_provider_configurations

Recupere detalhes de algumas ou de todas as configurações do provedor de eventos de App (configuração básica para o Rastreamento de Conversões de Aplicativo móvel) associadas à conta atual.
URL do recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta alavancada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, exceto em GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
count
opcional		Especifica o número de registros a serem recuperados por solicitação.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
opcional		Especifica um cursor para obter a próxima página de resultados. Consulte Pagination para mais informações.

Type: string

Example: 8x7v00oow
ids
opcional		Restringe a resposta apenas às configurações desejadas especificando uma lista de identificadores separada por vírgulas. É possível fornecer até 200 IDs.

Type: string

Example: 25n
sort_by
opcional		Ordena por um atributo compatível em ordem ascendente ou descendente. Consulte Sorting para mais informações.

Type: string

Example: created_at-asc
with_deleted
opcional		Inclui resultados excluídos na sua solicitação.

Type: boolean

Default: false
Possible values: true, false
with_total_count
opcional		Inclui o atributo de resposta total_count.

Observação: Este parâmetro e cursor são mutuamente exclusivos.

Observação: Solicitações que incluem total_count terão limites de requisições menores, atualmente definidos como 200 por 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Exemplo de requisição
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n
Exemplo de resposta
    {
      "data": [
        {
          "provider_name": "Answers com tecnologia Fabric",
          "id": "25n",
          "provider_advertiser_id": "54ac2766f0de9e1f7a00001a",
          "created_at": "2016-12-08T07:49:58Z",
          "provider_advertiser_identifier": "54ac2766f0de9e1f7a00001a",
          "updated_at": "2017-05-12T21:37:15Z",
          "deleted": false
        }
      ],
      "next_cursor": null,
      "request": {
        "params": {
          "ids": [
            "25n"
          ],
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
GET accounts/:account_id/app_event_provider_configurations/:id

Recupera um id específico das configurações do provedor de eventos (configuração principal para Rastreamento de Conversões de Aplicativo móvel) associadas à conta atual.
URL do recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, com exceção de GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
id
obrigatório		Uma referência à configuração do provedor de eventos de App com a qual você está operando na solicitação.

Type: string

Example: 25n
with_deleted
opcional		Incluir resultados excluídos na solicitação.

Type: boolean

Default: false
Possible values: true, false
Exemplo de requisição
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n
Exemplo de resposta
    {
      "data_type": "app_event_provider_configuration",
      "data": {
        "provider_name": "API McTestface",
        "id": "25n",
        "provider_advertiser_id": "123",
        "created_at": "2017-03-24T22:24:56Z",
        "provider_advertiser_identifier": "123",
        "updated_at": "2017-03-24T22:24:56Z",
        "deleted": false
      },
      "request": {
        "params": {
          "id": "25n",
          "account_id": "18ce54d4x5t"
        }
      }
    }
POST accounts/:account_id/app_event_provider_configurations
Crie uma nova configuração de provedor de eventos da App associada à conta atual. Apenas um provedor MACT pode ser associado a uma conta de anúncios específica.
URL do recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta vinculada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, com exceção de GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
provider_advertiser_id
obrigatório		O identificador do anunciante no site do provedor

Type: string

Example: client1
Exemplo de requisição
POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1
Exemplo de resposta
    {
      "data": {
        "provider_name": "InternalTestProvider",
        "id": "e5g",
        "provider_advertiser_id": "client1",
        "created_at": "2017-08-30T05:40:07Z",
        "provider_advertiser_identifier": "client1",
        "updated_at": "2017-09-06T06:39:03Z",
        "deleted": false
      },
      "request": {
        "params": {
          "provider_advertiser_id": "client1",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]

Exclui a configuração de provedor de eventos da App especificada, pertencente à conta atual.
URL do recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parâmetros
NomeDescrição
account_id
obrigatório		O identificador da conta utilizada. Aparece no caminho do recurso e geralmente é um parâmetro obrigatório para todas as solicitações da Advertiser API, exceto em GET accounts. A conta especificada deve estar associada ao usuário autenticado.

Type: string

Example: 18ce54d4x5t
id
obrigatório		Uma referência à configuração do provedor de eventos do App com a qual você está operando na solicitação.

Type: string

Example: e5g
Exemplo de requisição
DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g
Exemplo de resposta
    {
      "data": {
        "provider_name": "InternalTestProvider",
        "id": "e5g",
        "provider_advertiser_id": "client1",
        "created_at": "2017-08-30T05:40:07Z",
        "provider_advertiser_identifier": "client1"
        "updated_at": "2017-08-30T05:40:26Z",
        "deleted": true
      },
      "request": {
        "params": {
          "id": "e5g",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
Atribuição de conversão

​
GET conversion_attribution

Consulte o X para verificar a atribuição de conversão sem registrar um evento de conversão. A resposta indicará a atribuição do X. Isso se relaciona ao endpoint POST conversion_event. Na resposta, poderá ser indicada atribuição do X, do TAP ou nenhuma atribuição. O nó twitter_attribution estará sempre presente e terá o valor null quando não houver atribuição do X, sendo preenchido conforme mostrado no exemplo de resposta abaixo. Se a atribuição do TAP for indicada, um nó tpn_attribution estará presente e preenchido conforme apropriado. Consulte a visão geral do TAP para mais informações.
URL do recurso
https://ads-api.x.com/12/conversion_attribution
Parâmetros
NameDescription
app_id
required		O identificador exclusivo na respectiva loja de apps.

Type: int, string

Example: 333903271, com.vine.android
conversion_time
required		O horário do evento de conversão no formato de carimbo de data/hora ISO-8601, com milissegundos.

Type: string

Example: 2014-05-22T02:38:28.103Z
conversion_type
required		O tipo do evento de conversão.

Type: enum

Possible values: ACHIEVEMENT_UNLOCKED, ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, INSTALL, INVITE, LEVEL_ACHIEVED, LOGIN, PURCHASE, RATED, RESERVATION, RE_ENGAGE, SEARCH, SHARE, SIGN_UP, SPENT_CREDITS, TUTORIAL_COMPLETE, UPDATE
hashed_device_id
required		O IDFA ou AdID com hash HMAC_SHA-256.

Type: string

Example: ABCD1234XYZ
os_type
required		O tipo de SO do App.

Type: enum

Possible values: IOS, ANDROID
click_window
optional		A janela de clique para este evento, em dias.

Type: int

Default: 14
Possible values: 1, 7, 14, 30
extra_device_ids
optional		Um SHA256 do SHA1 do id do dispositivo passado em hashed_device_id, além de quaisquer ids de dispositivo adicionais com hash.

Type: string

Example: ABCD1234XYZ, DCBA4321XYZ
non_twitter_engagement_time
optional		O horário do último engajamento fora do X antes da conversão.

Type: string

Example: 2014-05-22T02:38:28.103Z
non_twitter_engagement_type
optional		O tipo de engajamento fora do X antes do evento de conversão.

Type: enum

Possible values: CLICK, VIEW
view_through_window
optional		A janela de visualização pós‑exposição para este evento, em dias.

Type: int

Default: 1
Possible values: 0, 1, 7, 14, 30
Exemplo de requisição
GET https://ads-api.x.com/12/conversion_attribution?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=0
Exemplo de resposta
    {
      data:{
        "app_id":"333903271",
        "os_type":"IOS",
        "hashed_device_id":"ABCD1234XYZ",
        "conversion_type":"INSTALL",
        "partner_client_id":"123abc",
        "conversion_time":"2013-04-16T07:00:00.123Z",
        "click_window":14,
        "view_through_window":0,
        "extra_device_ids":null,
        "twitter_attribution":{
          "engagement_type":"VIEW",
          "engagement_time":"2013-04-16T07:00:00.123Z",
          "country_code":"US",
          "tweet_id":"383034667764441088",
          "attribution_type":"PROMOTED",
          "promoted_properties":{
            "campaign_id”: “54a21",
            "campaign_name":"Vine_Contest",
          "line_item_id":"23ab2d4"
          }
        }
      },
      "data_type":"conversion_attribution",
      "request":{
        "params":{
          "app_id":"333903271",
          "os_type":"IOS",
          "hashed_device_id":"ABCD1234XYZ",
          "conversion_time":"2013-04-16T07:00:00.123Z",
          "conversion_type":"INSTALL",
          "click_window":14,
          "view_through_window":0
        }
      }
    }
⌘I