Mobile Conversions

MACT-Überblick

Die Messung der X Mobile App Promotion ermöglicht Werbetreibenden, den Erfolg von Werbekampagnen auf X zu erfassen, die auf App-Installationen oder andere In‑App-Conversions abzielen. Ein X Mobile Measurement Partner gibt Werbetreibenden die Möglichkeit, festzulegen, welche Conversions sie aus den auf X beworbenen Apps tracken möchten. Sobald der Werbetreibende die Ereignistypen und Zeitfenster definiert hat, sendet der Mobile Measurement Partner alle entsprechenden Events an X und erhält umgehend Attributionsdaten, die die Kampagne und das Creative ausweisen, mit denen der Nutzer interagiert hat und die zur Conversion geführt haben.

Conversion-Events

Um ein Conversion-Event an X zu melden und Attributionsdaten zu erhalten, muss der Partner die mobile App-ID, den Typ und den Zeitstempel der Conversion sowie einen gehashten Wert der Werbe-/Geräte-ID übermitteln. Die Bereitstellung dieser Daten erfasst das Conversion-Event auf der Plattform von X und liefert, wo zutreffend, die Attribution. Zusätzlich kann der Werbetreibende optional weitere Metadaten zum Conversion-Event angeben, wie den Wert eines Kaufs, die ID eines Produkts oder eine Registrierungsmethode.

API-Referenz

Conversion-Event

POST conversion_event

Erfassen Sie ein Conversion-Ereignis für Mobile Measurement. Die Antwort weist die Attribution für X oder die X Audience Platform (TAP) aus. Dies bezieht sich auf das GET conversion_attribution-Endpoint. In der Antwort wird entweder eine Attribution für X, für TAP oder keine Attribution ausgewiesen. Der Knoten twitter_attribution ist immer vorhanden und hat den Wert null, wenn keine X-Attribution vorliegt (siehe das untenstehende Beispiel der Antwort). Wenn eine TAP-Attribution ausgewiesen wird, ist ein Knoten tpn_attribution vorhanden und entsprechend befüllt. Weitere Informationen finden Sie in der TAP-Übersicht. Es stehen mehrere optionale Parameter zur Verfügung, um zu jedem Conversion-Ereignis zugehörige Metadaten festzulegen. Diese Metadaten haben keinen Einfluss auf Attributionsberechnungen.

Ressourcen-URL

https://ads-api.x.com/12/conversion_event

Parameter

Name	Beschreibung
app_id required	Der eindeutige Bezeichner im entsprechenden App Store. Type: int, string Example: `333903271`, `com.vine.android`
conversion_time required	Zeitpunkt des Conversion-Ereignisses im ISO-8601-Zeitstempelformat mit Millisekunden. Type: string Example: `2014-05-22T02:38:28.103Z`
conversion_type required	Der Typ des Conversion-Ereignisses. Type: enum Possible values: `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 required	Die HMAC_SHA-256-gehashte IDFA oder AdID. Type: string Example: `ABCD1234XYZ`
os_type required	Der OS-Typ der App. Type: enum Possible values: `IOS`, `ANDROID`
click_window optional	Das Klickfenster für dieses Ereignis in Tagen. Type: int Hinweis: `click_window` muss größer oder gleich view_through_window sein Default: `14` Possible values: `1`, `7`, `14`, `30`
device_ip_address optional	IPv4- oder IPv6-Adresse des Geräts zum Zeitpunkt des Conversion-Ereignisses. Type: string Example: `192.133.78.1`
level optional	Ein Level, das mit diesem Ereignis verknüpft ist. Type: int Example: `2`
non_twitter_engagement_time optional	Zeitpunkt der letzten Nicht‑Twitter-Interaktion vor der Conversion. Type: string Example: `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	Der Typ der Nicht‑Twitter-Interaktion vor dem Conversion-Ereignis. Type: enum Possible values: `CLICK`, `VIEW`
number_items optional	Anzahl der mit diesem Ereignis verknüpften Elemente. Type: int Example: `2`
price_currency optional	Erwartet wird ein ISO-4217-Code zur Angabe der mit diesem Ereignis verknüpften Währung. Type: string Examples: `EUR`, `USD`, `JPY`
price_micro optional	Ein mit diesem Ereignis verknüpfter Preisbetrag in Mikroeinheiten. Type: int Example: `123450000`
user_payment_info optional	Ein boolescher Wert, der angibt, ob die Zahlungsinformationen des Nutzers in der mit diesem Ereignis verknüpften App gespeichert sind. Type: bool Possible values: `true` or `false`
view_through_window optional	Das View-through-Fenster für dieses Ereignis in Tagen. Hinweis: `click_window` muss größer oder gleich view_through_window sein. Type: int Default: `1` Possible values: `0`, `1`, `7`, `14`, `30`

Beispielanfrage

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

Beispielantwort

    {
      "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"
        }
      }
    }

App-Ereignis-Tags

GET accounts/:account_id/app_event_tags

Rufen Sie Details zu einigen oder allen App-Event-Tags ab, die dem aktuellen Konto zugeordnet sind. Diese Tags definieren die für jeden Konversionstyp eingerichteten Conversion-Fenster für das Mobile App Conversion Tracking.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: `18ce54d4x5t`
app_event_tag_ids optional	Beschränken Sie die Antwort auf die gewünschten App-Event-Tags, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übermittelt werden. Type: string Example: `jhp`
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: `8x7v00oow`
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: `created_at-asc`
with_deleted optional	Schließen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count optional	Schließen Sie das Antwortattribut `total_count` ein. Hinweis: Dieser Parameter und `cursor` schließen sich gegenseitig aus. Hinweis: Anfragen, die `total_count` enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: `false` Possible values: `true`, `false`

Beispielanfrage

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

Beispielantwort

    {
      "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

Rufen Sie ein bestimmtes App-Event-Tag ab, das dem aktuellen Account zugeordnet ist. Diese Tags definieren die Konversionsfenster, die für das Mobile App Conversion Tracking pro Konversionstyp eingerichtet werden.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen, mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Beispiel: `18ce54d4x5t`
app_event_tag_id erforderlich	Eine Referenz auf den App-Event-Tag, mit dem Sie in der Anfrage arbeiten. Type: string Beispiel: `jhp`
with_deleted optional	Gelöschte Ergebnisse in die Anfrage einbeziehen. Type: boolean Standard: `false` Mögliche Werte: `true`, `false`

Beispielanforderung

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

Beispielantwort

    {
      "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

Erstellen Sie ein neues App-Ereignistag, das dem aktuellen Konto zugeordnet ist.

Resource-URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Example: `18ce54d4x5t`
app_store_identifier erforderlich	Die App-Store-Kennung. Type: string Example: `com.twitter.android`
conversion_type erforderlich	Der Typ des Conversion-Ereignisses. 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 erforderlich	Der OS-Typ der App. Type: enum Possible values: `IOS`, `ANDROID`
provider_app_event_id erforderlich	Die ID des Conversion-Tags auf der Website des Anbieters. Type: string Example: `provider_tag_j5394`
provider_app_event_name erforderlich	Der Name des Conversion-Tags auf der Website des Anbieters. Type: string Example: `provider_name_a4382`
deep_link_scheme optional	Geben Sie die Deep-Link-URI für die App an, die mit diesem Tag verknüpft ist. Type: string Example: `twitter://`
post_engagement_attribution_window optional	Das Attribution-Fenster nach Interaktion für diese Ereignisse. Type: int Default: 30 Possible values: `1`, `7`, `14`, `30`
post_view_attribution_window optional	Das Attribution-Fenster nach Ansicht für diese Ereignisse. Type: int Default: 1 Possible values: `0`, `1`, `7`, `14`, `30`
retargeting_enabled optional	Geben Sie an, ob Retargeting für dieses App-Event-Tag aktiviert werden soll. Type: boolean Default: true Possible values: `true`, `false`

Beispielanfrage

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

Beispielantwort

    {
      "data": {
        "provider_app_event_name": "test-tag",
        "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": "test-tag",
          "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

Löschen Sie das angegebene App-Event-Tag, das zum aktuellen Konto gehört.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das eingesetzte Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen, mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Beispiel: `18ce54d4x5t`
id erforderlich	Ein Verweis auf das App-Event-Tag, mit dem Sie in der Anfrage arbeiten. Type: string Beispiel: `jhp`

Beispielanfrage

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

Beispielantwort

    {
      "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"
        }
      }
    }

App Lists

GET accounts/:account_id/app_lists

Rufen Sie Details zu einigen oder allen App-Listen ab, die dem aktuellen Konto zugeordnet sind.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/app_lists

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: `18ce54d4x5t`
app_list_ids optional	Beschränken Sie die Antwort auf die gewünschten App-Listen, indem Sie eine durch Kommata getrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Typ: string Beispiel: `wm7x`
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Typ: int Standard: `200` Min, Max: `1`, `1000`
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Typ: string Beispiel: `8x7v00oow`
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Typ: string Beispiel: `created_at-asc`
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Typ: boolean Standard: `false` Mögliche Werte: `true`, `false`
with_total_count optional	Schließt das Antwortattribut `total_count` ein. Hinweis: Dieser Parameter und `cursor` schließen sich gegenseitig aus. Hinweis: Anfragen, die `total_count` enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Typ: boolean Standard: `false` Mögliche Werte: `true`, `false`

Beispielanforderung

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x

Beispielantwort

    {
      "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

Rufen Sie eine bestimmte App-Liste ab, die dem aktuellen Account zugeordnet ist.

Resource-URL

https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Typ: string Beispiel: `18ce54d4x5t`
app_list_id erforderlich	Ein Verweis auf die App List, mit der Sie in der Anfrage arbeiten. Typ: string Beispiel: `28ukf`
with_deleted optional	Gelöschte Ergebnisse in die Anfrage einbeziehen. Typ: boolean Standard: `false` Mögliche Werte: `true`, `false`

Beispielanfrage

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf

Beispielantwort

    {
      "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

Erstellen Sie eine app_list, die dem aktuellen Konto zugeordnet ist. Derzeit gilt ein Limit von 100 app_list-Objekten pro account_id und 500 Apps pro app_list.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/app_lists

Parameter

Name	Beschreibung
account_id erforderlich	Die Kennung des genutzten Kontos. Sie erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Beispiel: `18ce54d4x5t`
app_store_identifiers erforderlich	Die App-Store-Kennungen, die in die `app_list` aufgenommen werden sollen Type: string Beispiel: `com.twitter.android`
name erforderlich	Der Name, den Sie der `app_list` zuweisen Type: string Beispiel: `My First App List`

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android

Beispielantwort

    {
      "data": {
        "name": "App-Liste",
        "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": "App-Liste",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/app_lists/:app_list_id

Löscht die angegebene App-Liste, die dem aktuellen Konto zugeordnet ist.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Beispiel: `18ce54d4x5t`
app_list_id erforderlich	Ein Verweis auf die App List, mit der Sie in der Anfrage arbeiten. Type: string Beispiel: `28ukf`

Beispielanfrage

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf

Beispielantwort

    {
      "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"
        }
      }
    }

Konfigurationen für App-Ereignis-Provider

❯

GET accounts/:account_id/app_event_provider_configurations¶

Rufen Sie Details zu einigen oder allen Konfigurationen von App-Ereignis-Providern ab (Basiskonfiguration für Mobile Application Conversion Tracking), die dem aktuellen Account zugeordnet sind.

Ressourcen-URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations

Parameter

Name	Description
account_id required	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Example: `18ce54d4x5t`
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: `8x7v00oow`
ids optional	Beschränkt die Antwort auf die gewünschten Konfigurationen, indem eine kommagetrennte Liste von Bezeichnern angegeben wird. Es können bis zu 200 IDs angegeben werden. Type: string Example: `25n`
sort_by optional	Sortiert nach einem unterstützten Attribut in aufsteigender oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: `created_at-asc`
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count optional	Schließt das Antwortattribut `total_count` ein. Note: Dieser Parameter und `cursor` schließen sich gegenseitig aus. Note: Anfragen, die `total_count` enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: `false` Possible values: `true`, `false`

Beispielanforderung

GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n

Beispielantwort

    {
      "data": [
        {
          "provider_name": "Answers powered by 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

Ruft die spezifische id einer Event-Provider-Konfiguration (Grundkonfiguration für Mobile Application Conversion Tracking) ab, die dem aktuellen Konto zugeordnet ist.

Ressourcen-URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Ressourcenpfad und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: `18ce54d4x5t`
id erforderlich	Ein Verweis auf die App-Event-Provider-Konfiguration, mit der Sie in der Anfrage arbeiten. Type: string Example: `25n`
with_deleted optional	Gelöschte Ergebnisse in die Anfrage einbeziehen. Type: boolean Default: `false` Possible values: `true`, `false`

Beispielanforderung

GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n

Beispielantwort

    {
      "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

Erstellen Sie eine neue Konfiguration für den App-Event-Provider, die dem aktuellen Konto zugeordnet ist. Pro Anzeigenkonto kann nur ein MACT-Provider zugeordnet werden.

Ressourcen-URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations

Parameter

Name	Beschreibung
account_id required	Die Kennung des genutzten Kontos. Sie erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Example: `18ce54d4x5t`
provider_advertiser_id required	Die Kennung des Werbetreibenden von der Website des Providers Type: string Example: `client1`

Beispielanforderung

POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1

Beispielantwort

    {
      "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[¶]

Löscht die angegebene Konfiguration des App-Event-Providers, die zum aktuellen Konto gehört.

Ressourcen-URL

https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser‑API‑Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Beispiel: `18ce54d4x5t`
id erforderlich	Ein Verweis auf die Konfiguration des App‑Event‑Providers, mit der in der Anfrage gearbeitet wird. Type: string Beispiel: `e5g`

Beispielanfrage

DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g

Beispielantwort

    {
      "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"
        }
      }
    }

Conversion-Attribution

GET conversion_attribution

Führen Sie eine Abfrage bei X durch, um die Conversion-Attribution zu prüfen, ohne ein Conversion-Ereignis zu erfassen. Die Antwort zeigt die Attribution durch X an. Dies bezieht sich auf das endpoint POST conversion_event. In der Antwort wird entweder eine Attribution durch X, durch TAP oder keine Attribution ausgewiesen. Der Knoten twitter_attribution ist stets vorhanden und hat den Wert null, wenn keine X-Attribution vorliegt, und ist andernfalls wie im folgenden Beispiel befüllt. Wenn eine TAP-Attribution ausgewiesen wird, ist ein tpn_attribution-Knoten vorhanden und entsprechend befüllt. Weitere Informationen finden Sie in der TAP-Übersicht.

Ressourcen-URL

https://ads-api.x.com/12/conversion_attribution

Parameter

Name	Beschreibung
app_id required	Der eindeutige Bezeichner im jeweiligen App Store. Type: int, string Example: `333903271`, `com.vine.android`
conversion_time required	Der Zeitpunkt des Conversion-Ereignisses im ISO-8601-Zeitstempelformat mit Millisekunden. Type: string Example: `2014-05-22T02:38:28.103Z`
conversion_type required	Der Typ des Conversion-Ereignisses. 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	Die HMAC_SHA-256-gehashte IDFA oder AdID. Type: string Example: `ABCD1234XYZ`
os_type required	Der OS-Typ der App. Type: enum Possible values: `IOS`, `ANDROID`
click_window optional	Das Klickfenster für dieses Ereignis in Tagen. Type: int Default: `14` Possible values: `1`, `7`, `14`, `30`
extra_device_ids optional	Ein SHA256 des SHA1 der in `hashed_device_id` übergebenen Geräte-ID sowie beliebige zusätzliche gehashte Geräte-IDs. Type: string Example: `ABCD1234XYZ`, `DCBA4321XYZ`
non_twitter_engagement_time optional	Der Zeitpunkt der letzten Interaktion außerhalb von Twitter vor der Conversion. Type: string Example: `2014-05-22T02:38:28.103Z`
non_twitter_engagement_type optional	Der Typ der Interaktion außerhalb von Twitter vor dem Conversion-Ereignis. Type: enum Possible values: `CLICK`, `VIEW`
view_through_window optional	Das View-through-Fenster für dieses Ereignis in Tagen. Type: int Default: `1` Possible values: `0`, `1`, `7`, `14`, `30`

Beispielanfrage

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

Beispielantwort

    {
      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
        }
      }
    }

X Ads API

Grundlagen

Ressourcen

Messung

​MACT-Überblick

​Conversion-Events

​API-Referenz

​Conversion-Event

​POST conversion_event

Ressourcen-URL

Parameter

Beispielanfrage

Beispielantwort

​App-Ereignis-Tags

​GET accounts/:account_id/app_event_tags

Ressourcen-URL

Parameter

Beispielanfrage

Beispielantwort

​GET accounts/:account_id/app_event_tags/:app_event_tag_id

Ressourcen-URL

Parameter

​Beispielanforderung

​Beispielantwort

​POST accounts/:account_id/app_event_tags

Resource-URL

Parameter

Beispielanfrage

Beispielantwort

​DELETE accounts/:account_id/app_event_tags/:id

Ressourcen-URL

Parameter

Beispielanfrage

Beispielantwort

​App Lists

​GET accounts/:account_id/app_lists

Ressourcen-URL

​Parameter

Beispielanforderung

Beispielantwort

​GET accounts/:account_id/app_lists/:app_list_id

Resource-URL

Parameter

Beispielanfrage

Beispielantwort

​POST accounts/:account_id/app_lists

Ressourcen-URL

Parameter

Beispielanfrage

Beispielantwort

​DELETE accounts/:account_id/app_lists/:app_list_id

Ressourcen-URL

Parameter

Beispielanfrage

Beispielantwort

​Konfigurationen für App-Ereignis-Provider

​GET accounts/:account_id/app_event_provider_configurations¶

Ressourcen-URL

Parameter

Beispielanforderung

Beispielantwort

​GET accounts/:account_id/app_event_provider_configurations/:id

Ressourcen-URL

Parameter

Beispielanforderung

Beispielantwort

POST accounts/:account_id/app_event_provider_configurations

Ressourcen-URL

Parameter

Beispielanforderung

Beispielantwort

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

Ressourcen-URL

Parameter

Beispielanfrage

Beispielantwort

​Conversion-Attribution

​GET conversion_attribution

Ressourcen-URL

Parameter

MACT-Überblick

Conversion-Events

API-Referenz

Conversion-Event

POST conversion_event

App-Ereignis-Tags

GET accounts/:account_id/app_event_tags

GET accounts/:account_id/app_event_tags/:app_event_tag_id

Beispielanforderung

Beispielantwort

POST accounts/:account_id/app_event_tags

DELETE accounts/:account_id/app_event_tags/:id

App Lists

GET accounts/:account_id/app_lists

Parameter

GET accounts/:account_id/app_lists/:app_list_id

POST accounts/:account_id/app_lists

DELETE accounts/:account_id/app_lists/:app_list_id

Konfigurationen für App-Ereignis-Provider

GET accounts/:account_id/app_event_provider_configurations¶

GET accounts/:account_id/app_event_provider_configurations/:id

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

Conversion-Attribution

GET conversion_attribution