Conversion-API einrichten
Voraussetzungen
Zugriff auf die Ads API – neue Anträge
- Die wichtigste Voraussetzung für die Conversion API ist ein Developer-Konto und der Zugriff auf die Ads API. Der Prozess ist im Leitfaden Ads API – Erste Schritte beschrieben. Bitte beachten Sie Folgendes:
- Wenn Sie ein Developer-Konto beantragen, wählen Sie einen unserer Tarife für eine sofortige Freischaltung.
- Hinweis: Als Best Practice empfehlen wir dringend, den offiziellen X-Handle Ihres Unternehmens zu verwenden, um ein Developer-Konto zu erstellen und den Zugriff auf die Ads API zu beantragen. Wenn das Developer-Konto mit einem Entwickler-Handle verknüpft ist, können diese Anmeldedaten bei Bedarf nicht übertragen werden. Es ist am besten, dies unter einem Unternehmenskonto zu verwalten und bei Bedarf die Multi-User-Anmeldung zu nutzen. Andernfalls sollte das Konto mindestens mit individuellen Einstellungen eingerichtet sein (Headerbild, Avatar, Profilbeschreibung und Profil-URL) und die Zwei-Faktor-Authentifizierung verwenden.
- Stellen Sie sicher, dass Sie die richtige App-id für Ihren Ads API-Antrag bereithalten. Die App-id finden Sie im Entwicklerportal unter Projects & Apps. Beispiel: 16489123
- Fordern Sie Zugriff auf die Ads API an, indem Sie sich an Ihre X-Ansprechperson wenden.
Ads API-Zugriff – Bestehende Anwendungen
- Wenn Sie bereits eine aktiv genutzte Ads API-App haben, können sowohl die App als auch bestehende Access Tokens für die Conversion API verwendet werden.
Access Tokens
- User Access Tokens für den Nutzer-Handle, dem die Ads API-Anwendung gehört, können direkt im Entwicklerportal generiert und abgerufen werden. Dies wird als „persönlicher Access Token“ bezeichnet, da er für Ihren eigenen X-Handle gedacht ist. Allgemeine Informationen zur Authentifizierung und zum Entwicklerportal finden Sie hier.
- User Access Tokens für Nutzer-Handles, die nicht dem Ads API-Anwendungsinhaber gehören, müssen mit einem 3-legged OAuth-Flow generiert werden. Optionen zur Generierung des Access Token mit 3-legged OAuth umfassen:
- Alle mit der Conversion API verwendeten Nutzer-Tokens müssen für Nutzer mit dem Zugriffslevel AD_MANAGER oder ACCOUNT_ADMIN ausgestellt sein. Dies kann über das authenticated_user_access endpoint überprüft werden.
- Hinweis: Die Tokens selbst (nach der oben beschriebenen Erstellung) können zur Nutzung an Nutzer ohne das Zugriffslevel AD_MANAGER oder ACCOUNT_ADMIN weitergegeben werden.
Schritte
Erstellen des Conversion-API-Ereignisses
Option 1: Verwendung eines vorhandenen Conversion-Events im Ads Manager
conversion_id
) verwenden, um Events zwischen Pixel und Conversion API für dasselbe Event zu deduplizieren. Weitere Informationen finden Sie in Abschnitt d. Testing Events and Deduplication.
Option 2: Erstellen eines neuen Conversion-Events im Ads Manager:
- Gehen Sie zu ads.x.com
- Navigieren Sie oben links zum Abschnitt Tools und klicken Sie auf Events Manager
- Wählen Sie oben rechts Add event source, um Add an event source auszuwählen, falls in Ihrer linken Seitenleiste noch keine X Pixel-Eventquelle vorhanden ist
- Die ID der X Pixel-Eventquelle ist Ihre Pixel ID
- Wählen Sie innerhalb der X Pixel-Eventquelle auf der rechten Seite Add events
- Wählen Sie Install with Conversion API
- Sie sehen die Pixel ID und Event ID dieses Events, die in der API verwendet werden
- Die ID des Events ist Ihre Event ID
- Klicken Sie auf Save, und Ihr Conversion-Event ist erstellt und einsatzbereit
Vorbereiten von Identifikatoren für Conversion-Events
Derzeit muss mindestens ein Identifikator übergeben werden, etwa die Click ID (twclid
), eine E-Mail-Adresse oder eine Telefonnummer. Bei Verwendung von IP-Adresse oder User-Agent muss ein zweiter Identifikator gesendet werden, um ein korrektes Conversion-Matching zu gewährleisten.
Das Übermitteln weiterer Identifikatoren führt zu einer höheren Conversion-Matching-Rate.
Feld für Kundenabgleich | Format | Hashing erforderlich? |
X Click ID | Von X generiert (weitere Informationen) | Nein |
E-Mail-Adresse | Führende und nachgestellte Leerzeichen entfernen | Erforderlich (SHA256) |
Telefonnummer | E.164-Standard | Erforderlich (SHA256) |
IP-Adresse | Führende und nachgestellte Leerzeichen entfernen | Nein |
User-Agent | Führende und nachgestellte Leerzeichen entfernen | Nein |
1. X Click-ID-Bezeichner vorbereiten
Es wird empfohlen, die Click ID stets in die Conversion-Anfrage aufzunehmen. Die Click ID sollte aus dem query-String-Parameter twclid extrahiert werden, sobald sie verfügbar ist, nachdem der Nutzer zur Ziel-Website navigiert hat. Einfaches JavaScript-Beispiel:- Den twclid-Wert stets zu parsen, wenn er in den URL-Query-Parametern vorhanden ist.
- Die data zusammen mit relevanten Formularfeldern oder Informationen zu Conversion-Ereignissen zu speichern.
2. E-Mail-Identifikator vorbereiten
Unterstützte Customer-Matching-fields können übermittelt werden, sollten jedoch normalisiert und, falls erforderlich, gehasht werden, um die Privatsphäre zu schützen. Die Informationen müssen mit SHA-256 ohne Salt gehasht werden. Beispielsweise sollte eine E-Mail-Adresse wie test@x.com in gehashter Form an uns übermittelt werden: d360d510a224510f373931ce2d6215a799f5a9c1cef221b0149b6b6b50cced62.3. Telefonidentifikator vorbereiten
Die Telefonnummer sollte gemäß dem E.164-Standard übermittelt werden, und die Daten müssen ohne Salt mit SHA256 gehasht werden. Beispiel: Für eine US‑Telefonnummer +11234567890 sollte sie in gehashter Form an uns gesendet werden: 1fa6b8d986d9b9cd01bf36951815158bbde9f520c0567c835dfe34783d0a4231.4. IP-Adressidentifier vorbereiten
5. User-Agent-Bezeichner vorbereiten
Erstellen der Conversion-Event-Anfrage
POST: version/measurement/conversions/:pixel_id
Senden Sie Conversion-Events für ein bestimmtes Anzeigenkonto. Prüfen Sie den Antwortcode auf Erfolg (HTTP 200 OK). Es wird empfohlen, für den Fall zurückgegebener Fehlercodes einen Wiederholungsmechanismus und grundlegtes Logging einzusetzen.
Ausführliche Informationen zur URL des endpoints und zu den Parametern des POST-Body finden Sie im Abschnitt API Reference.
Beispielanforderung (zur besseren Lesbarkeit formatiert)
Beispiel-Antwort
Rate Limit
- Instrumentierung von Nutzeraktionen (Logging), um pro Ereignis korrekte Conversion-Daten senden zu können
- Alle erforderlichen Logiken, um Conversion-Ereignisse von Nutzern herauszufiltern, die relevante Datenschutzentscheidungen getroffen haben – zum Beispiel, wenn sie dem Tracking oder dem Verkauf ihrer personenbezogenen Daten auf der Website des Werbetreibenden widersprochen haben
- Integration mit Event-Triggern und Seiten, um Ereignisse zu erfassen und Conversions zu senden
Testen von Ereignissen und Deduplizierung
Testen von Events
- Datenexport im Ads Manager (Hilfeseite „Analytics for Website Conversion Tracking“)
- Export von data über die Ads API (segmentation_type=CONVERSION_TAGS)
Deduplizierung zwischen Pixel und Conversion API
Conversion-Tracking (Überblick)
Zusammenfassung
- Seitenbesuch: Nutzer besucht eine Landingpage auf der Website des Werbetreibenden
- Kauf: Nutzer schließt den Kauf eines Produkts oder einer Dienstleistung auf der Website des Werbetreibenden ab
- Download: Nutzer lädt eine Datei, etwa ein Whitepaper oder ein Softwarepaket, von der Website des Werbetreibenden herunter
- Anmeldung: Nutzer meldet sich für den Dienst, den Newsletter oder die E-Mail-Kommunikation des Werbetreibenden an
- Benutzerdefiniert: Sammelkategorie für eine benutzerdefinierte Aktion, die in keine der oben genannten Kategorien fällt
FAQ
Wie funktioniert das Conversion-Tracking-Tag?
Wie funktioniert das Conversion-Tracking-Tag?
Zunächst erstellt ein Werbetreibender ein Conversion-Tag, also ein von X bereitgestelltes Code-Snippet, und implementiert es auf seiner Website. Das Tag ist dann bereit, eine Conversion zu messen, sobald ein Nutzer die definierte Aktion ausführt.Nutzer sehen anschließend die Anzeige des Werbetreibenden im X-Client, die sie zur Website des Werbetreibenden und zur entsprechend getaggten Aktion führt. Wenn der Nutzer diese Aktion innerhalb des/der vom Werbetreibenden beim Einrichten des Tags festgelegten Attributionsfenster(s) abschließt, erkennt das Tag, dass der Nutzer zuvor mit einer X-Anzeige interagiert hat. Das Tag „feuert“ dann, d. h. es sendet eine Benachrichtigung an die Server von X, sodass die Conversion der Anzeige zugeschrieben werden kann, die sie ausgelöst hat.
Gibt es im Kampagneneinrichtungsprozess eine Möglichkeit, mit der der Nutzer auswählen kann, welche Tracking-Pixel für diese Kampagne relevant sind?
Gibt es im Kampagneneinrichtungsprozess eine Möglichkeit, mit der der Nutzer auswählen kann, welche Tracking-Pixel für diese Kampagne relevant sind?
Nein, unser Produkt ist nicht dafür ausgelegt, spezifische Conversion-Tags bestimmten Kampagnen zuzuordnen. Stattdessen verfolgt das System, sobald ein Tag eingerichtet ist, automatisch, welche Anzeige Conversions auf einem bestimmten Tag erzielt hat.
Was sind unsere Standard-Attributionsfenstereinstellungen für Conversion-Tags?
Was sind unsere Standard-Attributionsfenstereinstellungen für Conversion-Tags?
Welche Ideen gibt es für effektive DR-Creatives und Strategien, die Conversions effektiv steigern?
Welche Ideen gibt es für effektive DR-Creatives und Strategien, die Conversions effektiv steigern?
Auch wenn die Ziele, Ausgangssituationen und Strategien je nach Kunde variieren, finden Sie hier einige Ideen, die sich bei Kunden bewährt haben, die am Conversion-Tracking in der Alpha- oder Beta-Phase teilgenommen haben:Creative:
- Angebote: Kombinieren Sie einen Rabatt, eine Aktion oder kostenlosen Versand mit dem Promoted Tweet, um mehr Interesse an der gewünschten Aktion zu wecken
- Gewinnspiele und Wettbewerbe: Vor allem bei bekannten Marken führten Gewinnspiele und Wettbewerbe zu Conversions
- Experimentieren mit Tweet-Text: Testen von Groß- vs. Kleinschreibung (FREE vs. free bzw. NOW vs. now)
- Fristen: Setzen Sie eine Deadline, um Menschen zu sofortigem Handeln zu motivieren (Angebot endet am 12. Dezember!)
- Aussagekräftige Fotos hinzufügen: Es lohnt sich zu testen, ob visuell ansprechende Fotos im Tweet-Creative Conversions fördern; die Ergebnisse können variieren oder vom Angebot des Kunden abhängen.
- @handle-Targeting und Targeting nach Interessenkategorien: Eine enge Abstimmung von Tweet-Text und @Handles auf die intendierte Zielgruppe des Tweets förderte Conversions
- Nutzung von Nischen-, aber volumenstarken Keywords: Im Konzertbereich erwies sich die Verwendung von Keywords zum Künstler/Musiker (z. B. dessen Name) als effektiv.
- Tailored Audiences: Kunden, die TA Web und Conversion-Tracking gemeinsam nutzten, erzielten niedrigere CPAs als Kontrollgruppen mit anderen Targetings
Fehlerbehebung und Support für die Conversion API
Fehlerbehandlung und Erläuterung
Übersicht der Fehlercodes der X Ads API
Bei einem HTTP-Statuscode aus der 400er‑Reihe treten häufig folgende Fälle auf
- 400 Bad Request (Anfrage entspricht nicht den Standards)
- 401 Unauthorized (Authentifizierungsprobleme)
- 403 Forbidden (API‑Zugriffsprobleme im Zusammenhang mit diesem Developer-Konto)
- 404 Not Found (URL oder Parameter sind für das endpoint möglicherweise nicht korrekt)
Fehlercodes der Conversion-API
400 Bad-Request-Szenarien
Grund | Typ | Fehlermeldung |
---|---|---|
Fehlender Bezeichner (derzeit gehashte E-Mail oder X-Click-ID – twclid) | 400 Bad Request | Es muss mindestens ein Benutzerbezeichner angegeben werden |
Ungültige gehashte E-Mail | 400 Bad Request | Hashed_email ist kein gültiger SHA-256 hash |
Der type von event_id ist kein Single Event Tag (SET) | 400 Bad Request | Event_id (<event_id>) ist kein Single Event Tag (SET) |
Angeforderte Conversion-Ereignisse überschreiten das Limit (derzeit 500 Ereignisse pro Anfrage) | 400 Bad Request | Conversion Count Limit ist 500 |
Fehlende Event-ID | 400 Bad Request | Event-ID wurde nicht gefunden |
Beispiel für einen JSON-Fehlercode
Anfrage:
POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time":"2022-06-16T01:14:00.603Z","event_id":"o6dkt","identifiers":[{"twclid":"23opevjt88psuo13lu8d020qkn"}]}]}' --header 'Content-Type: application/json'
Fehlermeldung:
{"errors":[{"code":"INVALID_PARAMETER","message":"event_id (o6dkt) is not a single event tag (SET)","parameter":"event_id"}],"request":{"params":{"account_id":"18ce552mlaq"}}}
Anfrage:
twurl_ads -X POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time":"2022-06-16T01:14:00.603Z","event_id":"o6dl3","identifiers":[{"twclid":""}]}]}' --header 'Content-Type: application/json'
Fehlermeldung:
{"errors":[{"code":"INVALID_PARAMETER","message":"Es muss mindestens ein Benutzerbezeichner angegeben werden","parameter":""}],"request":{"params":{"account_id":"18ce552mlaq"}}}
Anfrage:
twurl_ads -X POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603Z", "event_id":"o6dl3", "identifiers": [{"hashed_email": "abc"}]}]}' --header 'Content-Type: application/json'
Fehlermeldung:
{"errors":[{"code":"INVALID_PARAMETER","message":"hashed_email (abc) is not a valid SHA-256 hash","parameter":"hashed_email"}],"request":{"params":{"account_id":"18ce552mlaq"}}}
Anfrage:
twurl_ads -X POST '/11/measurement/conversions/o6dkt' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603", "event_id":"o6dl3", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}]}]}' --header 'Content-Type: application/json'
Fehlermeldung:
{"errors":[{"code":"INVALID_PARAMETER","message":"Expected time in yyyy-MM-ddTHH:mm:ss.SSSZ, got \"2022-06-16T01:14:00.603\" for conversion_time","parameter":"conversion_time"}],"request":{"params":{"account_id":"18ce552mlaq"}}}
Grund: Authentifizierungsdaten fehlen oder sind falsch
Lösung: Befolgen Sie die Authentifizierungsschritte in der Einrichtungsdokumentation mit einer der drei Authentifizierungsmethoden:
User Access Tokens für andere Benutzerhandles als das Handle, dem die Ads API‑App gehört, müssen über einen 3-legged OAuth-Flow generiert werden. Optionen zum Generieren des Access Token mit 3-legged OAuth sind:
- Kommandozeile mit webbasiertem Autorisierungsfluss über das twurl‑Tool
- Kommandozeile mit PIN-basierter Autorisierung
- Benutzerdefinierter Web-Flow, der das 3-legged OAuth-Muster implementiert
403 Zugriff verweigert
Grund | Typ | Fehlermeldung |
---|---|---|
Das von Ihnen verwendete Developer-Konto hat keinen Zugriff auf die Ads API. Hier Zugriff beantragen. | 403 Unauthorized Client | Die Client‑Anwendung mit id <>, die diese Anfrage stellt, hat keinen Zugriff auf die X Ads API. Stellen Sie sicher, dass Ihre Anwendung über advertiser-api‑Zugriff verfügt. Verwenden Sie ‘twurl accounts’ und ‘twurl set default <username> <key>’, um die verwendete Anwendung zu ändern. |
404 Nicht gefunden
Grund | Typ | Fehlermeldung |
---|---|---|
Die Request-URL oder die Parameter sind für den endpoint nicht korrekt | 404 Route Not Found | Die angeforderte Ressource wurde nicht gefunden |
Sie haben keinen Zugriff auf das Konto, dem die pixel_id/Universal-Website-Tag gehört | 404 Not Found | User <user_id> does not have access to account <account_id>. Type ‘sn <user_id>’ to get the handle of the user. Use ‘twurl accounts’ and ‘twurl set default \u003Cusername\u003E’ to change the user you’re using. |
Die event id gehört nicht zu dem angegebenen Konto, das mit der pixel ID (UWT ID) verknüpft ist | 404 Not Found | event_id <event_id> gehört nicht zum angegebenen Konto |
Beispiel für einen JSON-Fehlercode
Anfrage:
twurl_ads -X POST '/11/measurement/conversions/o8z6j' --data '{"conversions":[{"conversion_time": "2022-06-16T01:14:00.603Z", "event_id":"abc", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}]}]}' --header 'Content-Type: application/json'
Fehlermeldung:
{"errors":[{"code":"NOT_FOUND","message":"event_id (abc) gehört nicht zum angegebenen Account","parameter":"event_id"},{"code":"INVALID_PARAMETER","message":"event_id (abc) ist kein Single Event Tag (SET)","parameter":"event_id"}],"request":{"params":{"account_id":"18ce55gze09"}}}
API-Referenzindex
Web-Conversions
Conversion-API | measurement/conversions/:pixel_id |
Web-Event-Tag | accounts/:account_id/web_event_tags |
Web Conversions
POST version/measurement/conversions/:pixel_id
Senden Sie Website‑Conversion‑Events für eine einzelne Event‑Tag‑ID.
Der Antwortcode sollte auf Erfolg geprüft werden (HTTP 200 OK). Es wird empfohlen, einen Retry‑Mechanismus und grundlegtes Logging vorzusehen, falls Fehlercodes zurückgegeben werden.
Das Rate Limit beträgt 100.000 Requests pro 15‑Minuten‑Intervall und Konto (jede Request erlaubt 500 Events).
Ressourcen-URL
https://ads-api.x.com/12/measurement/conversions/:pixel_id
Anforderungs-URL-Parameter
Name | Beschreibung |
---|---|
pixel_id erforderlich | Die Base-Tag-ID für ein Werbekonto. Dies ist der base36-codierte Wert der Base-Tag-ID eines Werbekontos. Type: string Beispiel: o8z6j |
conversions erforderlich | Das Objekt im POST-Body der API-Anfrage. Liste von Conversion-Ereignissen. Es können bis zu 500 Conversion-Ereignisse übermittelt werden. Siehe die Tabelle unten für unterstützte fields. Type: array Beispiel: "conversions":[{"conversion_time": "2022-02-18T01:14:00.603Z", "event_id":"o87ne", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}], "conversion_id": "23294827"}] |
conversions-Objekt
Name | Beschreibung |
---|---|
conversion_time erforderlich | Der Zeitpunkt im Format ISO 8601. Typ: string Beispiel: 2017-10-05T00:00:00Z |
event_id erforderlich | Die Base-36-ID eines bestimmten Events. Sie entspricht einem vorkonfigurierten Event innerhalb dieses Anzeigenkontos. Im entsprechenden Event im Events Manager wird dies als ID bezeichnet. Typ: string Beispiel: o87ne oder tw-o8z6j-o87ne (tw-pixel_id-event-id ) – beide werden akzeptiert |
identifiers erforderlich | Eine Liste von Identifier-Objekten, um das Conversion-Event abzugleichen. Unterstützte fields sind in der Tabelle unten aufgeführt. Mindestens eines der Identifier-Objekte ist erforderlich. Bei Verwendung von IP-Adresse oder User-Agent muss ein zweiter Identifier gesendet werden, um eine korrekte Zuordnung der Conversion sicherzustellen. Typ: array Beispiel: "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"},{"hashed_email": "e586883b2b4faf78d48300a79e0e15138d664cdf796ffb86e533170a9893eda8"}] |
number_items optional | Die Anzahl der im Event gekauften Artikel. Muss eine positive Zahl größer als null sein. Typ: integer Beispiel: 4 |
price_currency optional | Die Währung der im Event gekauften Artikel, angegeben gemäß ISO-4217. Siehe Currency für detaillierte Informationen. Typ: string Standard: USD Beispiel: JPY |
value optional | Der Preis der im Event gekauften Artikel, angegeben in der Währung price_currency .Typ: double Beispiel: 100.00 |
conversion_id optional | Zur Deduplizierung zwischen Pixel- und Conversion-API-Conversions. Ein Bezeichner für ein Conversion-Event, der für die Deduplizierung zwischen Web Pixel- und Conversion-API-Conversions im gleichen Event-Tag verwendet werden kann. Weitere Informationen finden Sie im Abschnitt „Testing Events and Deduplication“ des Conversions Guide. Typ: string Beispiel: 23294827 |
description optional | Beschreibung mit zusätzlichen Informationen zu den Conversions. Typ: string Beispiel: test conversion |
contents optional | Liste mit Details zu einem bestimmten Produkt/Content für granularere Angaben. Siehe Tabelle unten für unterstützte fields. Typ: array Beispiel: "contents": [{"content_id": "1", "content_name": "Blankets", "content_type": "home improvement", "content_price": 100.99, "num_items": 1, "content_group_id": "123"}, {"content_id": "2"}] |
Bezeichnerobjekt
Name | Beschreibung |
---|---|
twclid manchmal erforderlich | Klick-ID, wie sie aus der Click-through-URL geparst wird. Sie ist erforderlich, wenn kein anderer Bezeichner angegeben wird. Type: string Example: 26l6412g5p4iyj65a2oic2ayg2 |
hashed_email manchmal erforderlich | Eine mit SHA256 gehashte E-Mail-Adresse. Der Text muss kleingeschrieben sein; entfernen Sie vor dem Hashing alle führenden oder nachgestellten Leerzeichen. Erforderlich, wenn kein anderer Bezeichner angegeben wird. Type: string Example: Für test-email@test.com = e586883b2b4faf78d48300a79e0e15138d664cdf796ffb86e533170a9893eda8 |
hashed_phone_number manchmal erforderlich | Eine Telefonnummer im E164-Format, gehasht mit SHA256. Die Telefonnummer muss vor dem Hashing im E164-Format vorliegen. Erforderlich, wenn kein anderer Bezeichner angegeben wird. Type: string Example: Für +11234567890 = 1fa6b8d986d9b9cd01bf36951815158bbde9f520c0567c835dfe34783d0a4231 |
ip_address manchmal erforderlich | Dieser Wert wird in Punkt-Dezimal-Notation geschrieben, mit vier durch Punkte getrennten Zahlen. Die IP-Adresse muss zusammen mit einem anderen Bezeichner (twclid, E-Mail-Adresse, Telefonnummer oder User-Agent) übermittelt werden. Type: string Example: 8.25.197.25 |
**user_agent ** manchmal erforderlich | Dieser Bezeichner ermöglicht es dem Server, die Anwendung, das Betriebssystem, den Anbieter und/oder die Version des anfragenden User-Agents zu identifizieren. Der User-Agent muss zusammen mit einem anderen Bezeichner (twclid, E-Mail-Adresse, Telefonnummer oder IP-Adresse) übermittelt werden. Type: string Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36. |
contents object
Name | Description |
---|---|
content_id optional | SKU oder GTIN; Kennung, die den Inhalt repräsentiert. Type: string Example: jhp |
content_group_id optional | ID, die einer Gruppe von Produktvarianten zugeordnet ist Type: integer Example: group 1 |
content_name optional | Name des Produkts oder der Dienstleistung. Type: string Example: radio flyer |
content_price optional | Preis des Produkts oder der Dienstleistung. Type: double Example: 5.00 |
content_type optional | Kategorie des gekauften Produkts. Type: string Example: clothes |
num_items optional | Anzahl der gekauften Produkte Type: integer Example: 1 |
Antwortparameter
Name | Beschreibung |
---|---|
conversions_processed | Anzahl der erfolgreich verarbeiteten Conversions Typ: Integer Beispiel: 1 |
debug_id | Eine Debug-UUID, die für nachfolgende Untersuchungen verwendet werden kann Typ: String Beispiel: ff02e052-36e4-47d6-bdf0-6d8986446562 |
Beispielanfrage
Beispielanfrage
GET accounts/:account_id/web_event_tags
Ruft Details zu einigen oder allen mit dem aktuellen Konto verknüpften Web-Event-Tags ab.
Ressourcen-URL
https://ads-api.x.com/12/accounts/:account_id/web_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 Benutzer 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 |
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 |
web_event_tag_ids optional | Beschränkt die Antwort auf die gewünschten Web-Event-Tags, indem eine kommagetrennte Liste von Bezeichnern angegeben wird. Es können bis zu 200 IDs angegeben werden. Type: string Example: o3bk1 |
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.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/web_event_tags?web_event_tag_ids=o3bk1
Beispielantwort
GET accounts/:account_id/web_event_tags/:web_event_tag_id
Ruft ein bestimmtes Web-Event-Tag ab, das dem aktuellen Konto zugeordnet ist.Ressourcen-URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags/:web_event_tag_id
Parameter
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner des verwendeten Kontos. 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. Type: string Beispiel: 18ce54d4x5t |
web_event_tag_id erforderlich | Ein Verweis auf das Web-Event-Tag, mit dem Sie in der Anfrage arbeiten. Type: string Beispiel: o3bk1 |
with_deleted optional | Gelöschte Ergebnisse in die Anfrage einbeziehen. Type: boolean Standard: false Mögliche Werte: true , false |
Beispielanfrage
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags/o3bk1
Beispiel-Antwort
POST accounts/:account_id/web_event_tags
Erstellen Sie ein neues Web‑Event‑Tag, das dem aktuellen Account zugeordnet ist.Ressourcen-URL
https://ads-api.x.com/12/accounts/:account_id/web_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 Benutzer zugeordnet sein. Type: string Beispiel: 18ce54d4x5t |
click_window erforderlich | Das Klickfenster für dieses Web-Tag. Hinweis: Es werden nur die unten aufgeführten Werte akzeptiert. Type: int Mögliche Werte: 1 , 7 , 14 , 30 |
name erforderlich | Der Name des Web-Tags. Type: string Beispiel: Sample single conversion event |
retargeting_enabled erforderlich | Gibt an, ob Retargeting für dieses Web-Tag aktiviert werden soll. Type: boolean Mögliche Werte: true , false |
type erforderlich | Der Typ des Web-Tags. Type: enum Mögliche Werte: ADDED_PAYMENT_INFO , ADD_TO_CART , ADD_TO_WISHLIST , CHECKOUT_INITIATED , CONTENT_VIEW , CUSTOM , DOWNLOAD , PRODUCT_CUSTOMIZATION , PURCHASE , SEARCH , SIGN_UP , SITE_VISIT , START_TRIAL , SUBSCRIBE (In der UI wird SITE_VISIT als „Page view“ und SIGN_UP als „Lead“ angezeigt) |
view_through_window erforderlich | Das View-through-Fenster für dieses Web-Tag. Dieser Wert muss stets kleiner oder gleich dem Wert von click_window sein.Hinweis: Es werden nur die unten aufgeführten Werte akzeptiert. Type: int Mögliche Werte: 0 , 1 , 7 , 14 , 30 |
Beispielanfrage
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags?click_window=7&name=web event tag&retargeting_enabled=false&type=SITE_VISIT&view_through_window=7
Beispielantwort
PUT accounts/:account_id/web_event_tags/:web_event_tag_id
Aktualisiert ein dem aktuellen Konto zugeordnetes Web-Event-Tag.Ressourcen-URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags/:web_event_tag_id
Parameter
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner des genutzten Kontos. 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 |
web_event_tag_id erforderlich | Der Bezeichner eines Web-Tags im aktuellen Konto. Typ: string Beispiel: o3bk1 |
click_window optional | Das Click-Window für dieses Web-Tag. Hinweis: Es werden nur die unten aufgeführten möglichen Werte akzeptiert. Typ: int Mögliche Werte: 1 , 7 , 14 , 30 |
name optional | Der Name des Web-Tags. Typ: string Beispiel: Sample single conversion event |
retargeting_enabled optional | Gibt an, ob Retargeting für dieses Web-Tag aktiviert sein soll. Typ: boolean Mögliche Werte: true , false |
type optional | Der Typ des Web-Tags. Typ: enum Mögliche Werte: ADDED_PAYMENT_INFO , ADD_TO_CART , ADD_TO_WISHLIST , CHECKOUT_INITIATED , CONTENT_VIEW , CUSTOM , DOWNLOAD , PRODUCT_CUSTOMIZATION , PURCHASE , SEARCH , SIGN_UP , SITE_VISIT , START_TRIAL , SUBSCRIBE (In der UI wird SITE_VISIT als „Page view“ und SIGN_UP als „Lead“ angezeigt) |
view_through_window optional | Das View-through-Window für dieses Web-Tag. Dieser Wert muss stets kleiner oder gleich dem Wert von click_window sein.Hinweis: Es werden nur die unten aufgeführten möglichen Werte akzeptiert. Typ: int Mögliche Werte: 0 , 1 , 7 , 14 , 30 |
Beispielanforderung
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags/o3bk1?type=DOWNLOAD
Beispielantwort
DELETE accounts/:account_id/web_event_tags/:web_event_tag_id
Löscht ein bestimmtes Web-Event-Tag, das dem aktuellen Konto zugeordnet ist.Ressourcen-URL
https://ads-api.x.com/12/accounts/:account_id/web_event_tags/:web_event_tag_id
Parameter
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner des genutzten Kontos. 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 Example: 18ce54d4x5t |
web_event_tag_id erforderlich | Der Bezeichner eines Web-Tags im aktuellen Konto. Type: string Example: o3bk1 |
Beispielanfrage
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/web_event_tags/o3bk1