Zum Hauptinhalt springen

Custom Audiences

Übersicht

Es gibt mehrere Möglichkeiten für Partner, Custom Audiences zu erstellen. Bitte beachten Sie, dass Lookalike-Custom-Audiences nicht vom Targeting ausgeschlossen werden können. Außerdem können Sie nicht sowohl eine Custom Audience als auch eine Lookalike-Custom-Audience im selben Anzeigen-Positionselement (Anzeigengruppe) targeten. Audience-Verwaltung Audiences können über Audience-Partner und Ads API-Partner verwaltet werden. Wir bieten eine Reihe von endpoints in der API an, um auf Custom Audiences zuzugreifen und sie zu verwalten. Für Informationen zu Custom Audiences bieten wir 2 endpoints an: Weitere Details zum Hochladen und Verwalten von Audiences finden Sie im Audience API Guide. Verarbeitungszeiten Im Allgemeinen werden Änderungen an Audiences in Batches verarbeitet, die alle 6–8 Stunden laufen. Während eine Änderung verarbeitet wird, bleibt die bestehende, zu aktualisierende Audience unverändert. Wir empfehlen, innerhalb dieses Zeitraums nicht mehr als ein Update für Hinzufügungen und ein Update für Entfernungen pro Audience vorzunehmen. Targeting Eine Audience kann nur targetet werden, wenn sie mindestens 100 Nutzer umfasst, die in den letzten 90 Tagen auf X-eigenen und -betriebenen Clients aktiv waren. GET accounts/:account_id/custom_audiences/:custom_audience_id gibt an, ob eine Audience nicht targetet werden kann, weil sie zu wenige Nutzer umfasst. Audience API (CRM)
image2
Audience- oder API-Partner stellen eine Liste gehashter Kennungen bereit, und X führt ein Matching durch und erstellt Segmente, die für Media Buying auf X zur Verfügung gestellt werden. Partner können diese Audiences mit der Audience API erstellen. Wie funktioniert das?
image3
Web Wir bieten einen standardmäßigen Cookie-Matching-Prozess in Zusammenarbeit mit MPP-Audience-Partnern an, um Segmente zu identifizieren, die für Media Buying auf X targetet werden. Zusätzlich können Werbetreibende ein X Web Event Tag einrichten, um Website-Nutzerdaten zu erfassen und eine entsprechende Custom Audience zu erstellen. Einrichtungsschritte
image0
Wie funktioniert das?
image1
Mobile Details finden Sie im Blogbeitrag Custom Audiences from Mobile Apps. Flexibel Flexible Audiences geben Werbetreibenden die Möglichkeit, Audience-Kombinationen basierend auf bestehenden Custom Audiences oder Teilmengen bestehender Custom Audiences zu erstellen und zu speichern. Teilmengen der Mitglieder einer Custom Audience können basierend auf Aktualität und Häufigkeit der Interaktion targetet werden. Eingeschränkte Anwendungsfälle für Custom Audiences Mehr über Einschränkungen lesen

FAQ zu Zielgruppen

F: Wir haben eine große Menge an data übertragen. Warum wird die Zielgruppengröße als TOO_SMALL angezeigt? A: Derzeit werden die data in Echtzeit zur Zielgruppe hinzugefügt, aber der Prozess, der die data verarbeitet, um die Zielgruppengröße zu berechnen, läuft erst nach einiger Zeit. Die korrekte Zielgruppengröße sollte nach einigen Stunden in der UI angezeigt werden. F: Wir haben die Übermittlung der Zielgruppen-data abgeschlossen und 24 Stunden oder länger gewartet, können die Zielgruppe aber immer noch nicht targeten – was sollten wir als Nächstes tun? A: Bitte prüfen Sie Folgendes:
  • Die übergebene user ID ist korrekt und nicht fehlerhaft.
  • Die übergebenen Zielgruppennamen sind korrekt und stimmen mit früheren Membership-Updates überein.
  • Bitte prüfen Sie die Antwort auf die POST-Befehle.
  • Bitte bestätigen Sie, dass das ID Sync-Pixel korrekt implementiert ist und dass, wie im ID Sync-Prozess beschrieben, genügend Nutzer die betreffende Website besucht haben, um Nutzer zuzuordnen. Nicht zugeordnete Nutzer in den Membership-Updates werden nicht in targetbare Nutzer überführt.
Wenn alles andere als korrekt und funktionsfähig bestätigt wurde, kontaktieren Sie bitte Ihre X Produktansprechpartner mit so detaillierten Informationen wie möglich (siehe Guide to Partner Inbounds für ein Beispiel bevorzugter Informationen). F: Wie oft können wir das endpoint aufrufen, und mit welchem Algorithmus? A: Wir empfehlen dringend, unser System mit inkrementellen Deltas aufzurufen und niemals die vollständigen Zielgruppenmitgliedschaften erneut zu senden. Das System wurde auf einen Durchsatz getestet, der ausreicht, um inkrementelle data-Updates für einige der größten Websites der Welt zu verarbeiten. Der initiale Upload von Zielgruppen sollte sorgfältig gedrosselt werden; es ist zu erwarten, dass der erste Upload eine beträchtliche Zeit in Anspruch nimmt. F: Wie groß muss eine Zielgruppe mindestens sein, um für Targeting verwendet zu werden?
  • Die Mindestgröße für eine Zielgruppe beträgt 100 Nutzer (nach Match). Wenn eine Zielgruppe mit weniger als 500 Nutzern gematcht wird, steht sie in der X Ads UI nicht für Targeting zur Verfügung.
F: Wie lange dauert die Verarbeitung der Zielgruppendateien? Und wie lange dauert es, bis die Zielgruppendateien in der X Benutzeroberfläche bereitstehen?
  • Die Verarbeitung der Zielgruppendateien dauert typischerweise 4–6 Stunden, abhängig von der Dateigröße. Sobald die Datei verarbeitet ist, stehen die Zielgruppen in der X Ads UI zur Verfügung.
F: Wie wird die Match-Rate berechnet?
  • Match-Rate = aktive X Nutzer der letzten 90 Tage / Anzahl der bereitgestellten Nutzer
F: Wie testen wir, ob eine Zielgruppendatei ordnungsgemäß funktioniert?
  • Sie können eine Test-Zielgruppendatei bereitstellen und „keltonlynn“ als Advertiser-Handle verwenden. Wir können dann verifizieren, dass die Datei ordnungsgemäß ingestiert und in die X UI geladen werden kann.
F: Was ist ein Partnernutzer-Identifikator (p_user_id)?
  • Dies ist der Identifikator, den Ihr Unternehmen verwendet, um jeden Ihrer Kunden eindeutig zu identifizieren.
F: Was ist eine Standard-ID?
  • Dies kann eine E-Mail-Adresse, Geräte-ID, X @Handle oder ID sein.
F: Wie erhalte ich den HMAC-Schlüssel?
  • Dieser wird per verschlüsselter E-Mail bereitgestellt. Bitte senden Sie Ihren öffentlichen PGP-Schlüssel an mpp-inquiry@x.com und wir senden Ihnen eine Test-E-Mail, um zu verifizieren, dass alles funktioniert. Nach der Verifizierung senden wir Ihnen den HMAC-Schlüssel.
F: Wie überprüfe ich, dass der Hashing-Prozess mit dem angegebenen HMAC-Schlüssel funktioniert hat?
  • X stellt eine Testdatei (mit beispielhaften E-Mail-Adressen, Geräte-IDs usw.) und eine resultierende hash-Datei bereit, anhand derer Sie Ihre Ergebnisse verifizieren können.
F: Gibt es eine Größenbeschränkung für die Full Data Match-Datei?
  • Nein, es gibt keine Größenbeschränkung für die Full Data Match-Datei.
F: Wie lange dauert es, bis die Full Data Match-Datei verarbeitet ist?
  • Sobald die Datei von X empfangen wurde, dauert die Verarbeitung ungefähr 1 Tag.

CRM

image0
Dieses Dokument beschreibt die Integrationsdetails für Custom Audiences von CRM-Partnern, einschließlich Dateiformaten und des Datenaustauschprozesses. Zusammenfassung Das Unternehmen stellt im Auftrag eines Kunden eine Liste gehashter, gängiger Benutzerkennungen (z. B. E‑Mail‑Adressen) oder Partner‑Benutzer‑IDs an X bereit, um ein Blind‑Matching durchzuführen und eine Liste von X User IDs für das Targeting zu erstellen. Die Zielsegmente werden für das spezifische @handle des Werbetreibenden bereitgestellt, das durch den Dateinamen im Kampagnen‑Setup auf ads.x.com angegeben ist. Alle Dateien des Unternehmens werden X über ein sicheres Paket auf IronBox (www.golockbox.com) über ein spezielles, von X dem Unternehmen zugewiesenes Konto bereitgestellt. X gewährt den Zugriff auf IronBox. Die Dokumentation zu den IronBox APIs ist unter https://secure.goironcloud.com/Docs/Help/ verfügbar.

Anforderungen für das Abgleichen von Partner-IDs

Wenn ein Unternehmen sein eigenes standardisiertes ID-System zur Nachverfolgung von Nutzern verwendet (d. h. keine gängigen Nutzerkennungen wie E-Mail-Adressen, Geräte-IDs, X Nutzer-ID usw.), wird folgender Prozess empfohlen. 1. Vollständiger Datenabgleich Zu Beginn stellt das Unternehmen eine umfassende Liste aller Nutzerdatensätze bereit, die in einer einzigen Datei eine eindeutige, gemeinsame Nutzerkennung mit X enthalten, um einen vollständigen Datenabgleich durchzuführen und eine von X gespeicherte Zuordnung von Partner-IDs (p_user_id) zu X-IDs (tw_id) zu erstellen. Dies wird regelmäßig im Abstand von 2–3 Monaten durchgeführt, um eine ordnungsgemäße Pflege sicherzustellen. Sobald der Abgleich abgeschlossen ist, teilt X dem Unternehmen auf Basis dieser Datei eine Ausgangs-Abgleichsrate per E-Mail mit. Das Format dieser Datei sollte wie folgt sein: Namenskonvention: FullDataMatch.[CompanyName].txt Hashing-Algorithmus: HMAC_SHA-256 Format: Spalte 1: HMAC-gehashter Wert der gemeinsamen Kennungen Spalte 2: Partner User ID (pro Nutzer eindeutig, in der Datei nicht eindeutig) Spaltentrennzeichen (CSV): Kommas trennen die gehashte gemeinsame Nutzerkennung von der Partner-ID Zeilenweise getrennte Werte
  • Bsp.: Wenn der Nutzerdatensatz A die Partner User ID 1 und die gemeinsamen Kennungen 1, 2 und 3 hat:
gemeinsame Nutzerkennung 1p_user_1
gemeinsame Nutzerkennung 2p_user_1
gemeinsame Nutzerkennung 3p_user_1
*Siehe unten den Abschnitt „Hashing-Anweisungen“ für gemeinsame Nutzerkennungen 2. Benutzerdefinierte Segmentlisten Das Unternehmen stellt Listen von Nutzern in Form von p_user_id bereit, um benutzerdefinierte Zielgruppen für Kunden zum Targeting auf X zu erstellen.
  • Zeilenweise getrennte Werte
  • p_user_id
    • (Entspricht dem in Abschnitt 1. Vollständiger Datenabgleich oben bereitgestellten Format. Wenn der im vollständigen Datenabgleich bereitgestellte Wert gehasht ist, stellt das Unternehmen denselben gehashten Wert in der Audience-Datei bereit. Wenn der bereitgestellte Wert nicht gehasht ist, stellt das Unternehmen den ungehashten Wert bereit.)

Standardanforderungen für das Matching

Wenn ein Unternehmen keine standardisierte id für die Zuordnung aller Kunden-Benutzerkennungen verwendet, ist dies der empfohlene Prozess. Benutzerdefinierte Segmentlisten Das Unternehmen stellt im Namen der Kunden Listen mit gehashten, gängigen Benutzerkennungen direkt X zur Verfügung, um benutzerdefinierte Zielgruppen zu erstellen. Das Format dieser Datei sollte wie folgt sein:
  • Zeilenweise getrennte Werte
  • Gehashte, gängige Benutzerkennung (z. B. E-Mail-Adresse)
  • Befolgen Sie die unten beschriebenen Konventionen zur Dateibenennung
  • Befolgen Sie die unten stehenden Anweisungen zum Hashing von E-Mail-Adressen (unter „Hashing Directions“)

Benutzerdefinierte Segment-Listen: Dateibenennung und Operationen

Die Operation einer Datei wird durch ihren Namen bestimmt. Verfügbar sind die folgenden Operationen; die allgemeine Benennungskonvention lautet: audiencename_partnername.handle.operation.filetype
  • audiencename: Der Name der Custom Audience. Dieses Feld ist der Name, der beim Auswählen der Zielgruppe in der Kampagnen-Setup-UI auf ads.x.com angezeigt wird, z. B. brand_loyalty_card_holders.
  • partnername: Name des Unternehmens, das die data im Auftrag des Werbetreibenden liefert, z. B. company_name.
  • handle: X Account (@handle), der Zugriff auf Custom Audiences hat, z. B. @pepsi, @dietpepsi
  • operation: new, add, remove, removeall, replace (Details unten)
  • timestamp: Standard-Unix-Epoch-Zeit in Sekunden; wird verwendet, um sicherzustellen, dass jede hochgeladene Audience-Datei eindeutig ist
  • filetype: Datei muss im *.txt-Format vorliegen

Erstellen und Aktualisieren von Zielgruppen

Erstellen Sie eine neue Zielgruppe mit einer einzelnen Datei, z. B. loyalty_card_holders_partnername.pepsi.new.txt Hinzufügen – Fügen Sie die Übereinstimmungen aus einer Liste zu einer bestehenden Zielgruppe hinzu, z. B. loyalty_card_holders_partnername.pepsi.add..txt Entfernen – Entfernen Sie die Übereinstimmungen aus einer Liste aus einer bestehenden Zielgruppe, z. B. loyalty_card_holders_partnername.pepsi.remove..txt Alle entfernen – Entfernen Sie die aus einer regelmäßig aktualisierten kumulativen Liste stammenden Übereinstimmungen aus allen Zielgruppen für diesen Kunden (d. h. Opt-out-Liste des Kunden). Z. B.: partnername.pepsi.removeall.txt
  • Dies kann für eine umfassende Liste von Nutzern verwendet werden, die sich beim Advertiser abgemeldet haben.
  • X berücksichtigt nur die neueste in dieser Datei bereitgestellte Liste und wendet sie auf alle bestehenden und zukünftigen Zielgruppen für abgeglichene
X Nutzer zum Zeitpunkt der Bereitstellung und Verarbeitung dieser Datei an. Ersetzen – Entfernen Sie eine bestehende Zielgruppe und ersetzen Sie sie durch eine neue Zielgruppenliste. Z. B.: loyalty_card_holders_partnername.pepsi.replace..txt Unternehmensweites Opt-out – Das Unternehmen stellt eine kumulative Opt-out-Datei bereit, um Nutzer zu entfernen, die gemäß der Opt-out-Richtlinie des Unternehmens widersprochen haben. X berücksichtigt nur die neueste in dieser Unternehmens-Opt-out-Datei bereitgestellte Liste und wendet sie auf alle bestehenden und zukünftigen Zielgruppen für abgeglichene X Nutzer zum Zeitpunkt der Bereitstellung und Verarbeitung dieser Datei an. Das Format der Unternehmens-Opt-out-Datei ist wie folgt: Z. B.: partnername.removeall.txt Delete – Entfernen Sie eine bestehende Zielgruppe aus der aktuellen Liste der Zielgruppen, z. B.: loyalty_card_holders_partnername.pepsi.delete.txt

Anweisungen zum Hashing

X wird einen Base64-kodierten Produktionsschlüssel sicher per PGP bereitstellen, um gängige Benutzerkennungen (z. B. E‑Mail‑Adressen) zu hashen. Das Unternehmen dekodiert den Schlüssel aus Base64, um einen 32‑Byte‑Schlüssel zu erhalten, der für das Hashing verwendet wird. Beispiel für einen Base64-kodierten Schlüssel: BrQvOg+dACBUmKjRiNxZgJLh6zydjS0ZOv80FelTNzM= Beispiel für einen aus Base64 dekodierten Schlüssel: /:� TшY Normalisierung: Das Unternehmen führt vor dem Hashing eine grundlegende Normalisierung der gängigen Benutzerkennungen durch (ausgenommen Geräte-IDs, siehe Abschnitt „Normalisierung von Geräte-IDs“).

E-Mail-Normalisierung

Entfernen Sie führende und nachfolgende Leerzeichen und wandeln Sie die E-Mail-Adresse in Kleinbuchstaben um. Beispiel: Roh-E-Mail-Adresse: testemail_Organisational_baseball+884@It92I6Ev2B.Com Nach der Normalisierung: testemail_organisational_baseball+884@it92i6ev2b.com Hash-Wert: 74d9584eded0ad1e5572a1c1849f3716751d371d6117a6155dad5363f4b4fbec Hinweis: Die Anzahl der Zeichen sowohl für das kodierte hmac als auch für den Schlüssel kann je nach Eingabe und Kodierung variieren.

Normalisierung von Geräte-IDs

Für das Hashing von Geräte-IDs gelten dieselben Anforderungen: Verwendung des SHA-256-Algorithmus und eines gemeinsamen Salts, den wir unseren Datenpartnern bereitstellen. Wie bei E-Mail-Adressen entfernen wir Leerzeichen, jedoch erfolgt keine Kleinschreibungs-Normalisierung für IDFA/Android-ID; es ist das exakte Format der IDFA/Android-ID zu verwenden. Hier ein Beispiel für das Rohformat von Geräte-IDs für iOS und Android vor dem Hashing: iOS-IDFA: DD99CFF7-6186-4602-9DF2-ED3FD0B2D431 Android-ID: b5bf2122961b3595 Gehashte iOS-IDFA: 134fb8cd95c7fd42e2793f469a447198ca5f990968db2dbadad70e723ed9750b Gehashte Android-ID: 130dddff1939f229476f50bc8adab8fcb7e3525b0e9604fe8effc15e68cee4a4

Normalisierung der X User ID

X IDs werden weiterhin gehasht, da die Gruppierung von data – d. h. eine Customer List aus @handles – für den Werbetreibenden privat ist, auch wenn es sich nicht um PII handelt. Für das Hashing von X IDs gelten die gleichen Anforderungen: Verwendung des SHA-256-Algorithmus und eines gemeinsamen Salts, den wir Datenpartnern bereitstellen. Leerzeichen sollten sowohl aus der X ID bzw. dem @username entfernt werden; User IDs müssen jedoch nicht normalisiert werden. @usernames sollten zur Normalisierung in Kleinbuchstaben umgewandelt werden. Das @-Symbol darf nicht als Teil des Usernamens enthalten sein. Das Rohformat der ID lautet:
  • User ID: 27674040
  • @username: testusername
Gehashte User ID: bf6b57d4e861e83bea8bbed2b800b251a64c95468ee6e8cb07c3368c9ed45e85 Gehashter @username: 12201ae78ad1afa907c7112d17f498154ffb0bf9ea523f5390e072a06d7d9812

ID-Sync-Integration

Partner, die Daten mit einer p_id senden, müssen einen ID-Sync-Prozess durchlaufen, um eine Zuordnung der Nutzer-ids des Werbetreibenden oder Partners zu X Nutzer-ids zu erstellen. Dies ermöglicht es Werbetreibenden, ihre eigenen Nutzersegmente direkt auf X zu targeten. Partner müssen außerdem beim Senden ihrer Mitgliederaktualisierungen den Wert des Parameters user_identifier_type auf entweder TALIST_PARTNER_USER_ID oder TAWEB_PARTNER_USER_ID setzen.
  • Nur Web: Dies kann durch das Platzieren eines Pixels auf der Website des Werbetreibenden erfolgen, wie unten beschrieben.
  • List: Dies kann mit einer der auf der Seite CRM beschriebenen Methoden erfolgen.

Pixel-URL

Stamm-URL
https://analytics.x.com/i/adsct

Pixel-Parameter

ParameterBeschreibung
p_idIhre von X zugewiesene Partner-id
p_user_idDie id des Nutzers im Partner-System

ID-Sync-Pixel:

Bei einer Beispiel-Partner-id von 111 und einer Beispiel-p_user_id von abc würde der erzeugte Pixel wie folgt aussehen:
    <pre class="brush: xml">
    <img height="1" width="1" src="https://analytics.x.com/i/adsct?p_id=111&p_user_id=abc" style="display:none" />
    </pre>
Konfiguration der Opt-out-Datei und Senden von Opt-out-Dateien Partner sollten X eine Liste von Nutzern bereitstellen, die nach bestem Wissen des Partners der Auslieferung zielgerichteter Werbung widersprochen haben (Opt-out). Die Datei sollte folgendem Format entsprechen:
SpaltennummerSpaltennameSpaltentypBeschreibung
1Partner-IDstringDie „partner id“ ist die ID, die X dem Partner zur eindeutigen Identifizierung jedes Partners zuweist.
2Nutzer-id im Partner-SystemstringDie p_user_id ist die eindeutige ID, mit der der Partner den Nutzer identifiziert. Die Datei mit diesen Opt-out-Nutzern sollte über den TON upload endpoint hochgeladen werden, und der Pfad der hochgeladenen data sollte an den Global-Opt-Out-endpoint hier gesendet werden: PUT accounts/:account_id/custom_audiences/global_opt_out.
Senden von Mitgliedschafts-Updates Wie in unserer endpoint-Dokumentation angegeben, sollten Sie beim Übermitteln von Nutzern über den POST custom_audience_memberships endpoint eine Kunden-ID übermitteln, um ein Cookie-basiertes Matching zu ermöglichen. Partner, die data mit einer p_id senden, müssen user_identifier_type auf TALIST_PARTNER_USER_ID oder TAWEB_PARTNER_USER_ID setzen. Alle anderen Schritte bleiben identisch mit denen, die im Real-Time Audience API Integration Guide aufgeführt sind.

Benutzerdaten für Custom Audiences

Dieses Dokument beschreibt das Format für Benutzerdaten von [Custom Audience]/x-ads-api/audiences. Daten-Normalisierung Geräte-IDs:
  • IDFA – in Kleinbuchstaben mit Bindestrichen; z. B.: 4b61639e-47cc-4056-a16a-c8217e029462
  • AdID – Originalformat des Geräts erforderlich, nicht großgeschrieben und mit Bindestrichen; z. B.: 2f5f5391-3e45-4d02-b645-4575a08f86e
  • Android-id – Originalformat des Geräts erforderlich, nicht großgeschrieben und ohne Bindestriche oder Leerzeichen; z. B.: af3802a465767e36
E-Mail-Adressen:
  • in Kleinbuchstaben, führende und nachgestellte Leerzeichen entfernen; z. B.: support@x.com
X-Benutzernamen:
  • ohne @, in Kleinbuchstaben und führende sowie nachgestellte Leerzeichen entfernen; z. B.: jack
X-Benutzer-IDs:
  • Standard-Integer; z. B.: 143567
Daten-Hashing Die Daten jeder Zeile müssen ohne Salt mit SHA256 gehasht werden. Zusätzlich muss der endgültige Hash in Kleinbuchstaben vorliegen. Z. B. 49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d und nicht 49E0BE2AECCFB51A8DEE4C945C8A70A9AC500CF6F5CB08112575F74DB9B1470D
# Hashing von Benutzer @AdsAPI mit Python
import hashlib
hashlib.sha256("adsapi".encode()).hexdigest()

#Ausgabe
49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d
Weitere Codebeispiele zum Hashing finden Sie unter github.com/xdevplatform/ads-platform-tools.

Custom Audiences: Web

info.png
Information Partner senden im Namen eines Werbetreibenden eine Liste von IDs (p_user_ids) zur Zielgruppenansprache. Dies geschieht über einen ID-Sync-Prozess, der eine Zuordnung zwischen den p_user_ids und der X-User-ID erstellt. Diese Zuordnung wird anschließend verwendet, um Listen von X-User-IDs zu erzeugen, die für das Targeting genutzt werden können. Diese Custom Audiences werden im spezifischen @Handle des Werbetreibenden verfügbar gemacht, wie durch das Label in der ads.x.com Custom Audiences Web-Kampagneneinrichtung angegeben. X stellt das Secure Pixel bereit, das in Partner-Tags und -Sites eingebunden werden kann, um die IDs (p_user_ids) mit X-User-IDs abzugleichen. Sobald der ID-Sync-Prozess abgeschlossen ist, werden die Targeting-Dateien vom Partner erstellt und X über ein HTTPS-endpoint zur Verfügung gestellt. Diese Targeting-Dateien werden von X regelmäßig ingestiert und anschließend in der X UI verfügbar gemacht. X Secure Pixel Das X Secure Pixel sieht wie folgt aus: https://analytics.x.com/i/adsct?p&#95;user&#95;id=xyz&amp;p&#95;id=123 p_user_id - xyz steht für die Partner-User-ID, die vom Partner bereitgestellt wird p_id - 123 steht für die eindeutige ID des Partners (bereitgestellt von X) Partner HTTPS Endpoint & Targeting User File Der Partner muss X ein HTTPS-endpoint und Zugangsdaten (Benutzername/Passwort) bereitstellen, die verwendet werden können, um die Targeting-Datei regelmäßig zu ingestieren. Ein Beispiel-HTTPS-endpoint sieht wie folgt aus:
https://<partnerdomain>/twitter/partner_targeting_%Y-%M-%D.tsv.gz
%Y - Formatcode für Jahr (YYYY) %M - Formatcode für Monat (MM) %D - Formatcode für Tag (DD) Die übertragenen data bestehen aus den folgenden Dateien:
  1. Partner Targeting User File
  2. Targeting Conversion File
Alle Dateien liegen im TSV-Format vor, bei dem die einzelnen fields jeder Zeile durch ein Tabulatorzeichen voneinander getrennt sind. Gültige Feldwerte enthalten selbst niemals das Tabulatorzeichen. Zulässiger X-IP-Bereich: Hier ist der IP-Bereich, der für den Zugriff auf den Partner-endpoint zugelassen werden kann.
  • 199.16.156.0/22
  • 199.59.148.0/22
Partner Targeting User File:
SpaltennummerSpaltennameSpaltentypBeschreibung
1partner idstringDie „partner id“ ist die ID, die X dem Partner bereitstellt, um jeden Partner eindeutig zu identifizieren.
2advertiser idstringDie „advertiser id“ ist der @handle des Werbetreibenden.
3p_user_idstringDie „p_user_id“ ist die eindeutige ID, mit der der Nutzer vom Partner identifiziert wird.
3confidence scoreintegerDer „confidence score“ ist optional. Unsere Empfehlung für den confidence score ist 0–100. Wenn der Anwendungsfall Retargeting ist, steht ein confidence score von „100“ für einen Nutzer, der direkt retargeted wurde. Jeder Wert von 0–99 entspricht dem Vertrauensniveau des Lookalikes.
4segment labelstringDas „segment label“ ist optional. Partner können „segment label“ verwenden, um beispielsweise Produktkategorien anzugeben. Wir empfehlen, dieses „segment label“ zu verwenden, da dies der menschenlesbare Name für Custom Audiences in der ads.x.com UI ist.
Hinweise: Jedes Mal, wenn wir eine neue Partner Targeting File erhalten, erwarten wir die vollständige Liste der Nutzer, die der Partner für das Targeting empfiehlt, nicht inkrementell, sofern nicht anders vereinbart. Wir legen mit jedem Partner die Lieferfrequenz dieser Partner Targeting File fest. Wenn wir eine Partner Targeting File nicht wie erwartet erhalten, verwenden wir die vorherige Version mit einer vordefinierten Ablaufzeit.

Integration der Audience API

Übersicht

Die Audience API wurde als Teil von v4 der Ads API eingeführt und bringt mehrere Verbesserungen gegenüber den veralteten Audiences-endpoints. Dieses neue endpoint wird von einem neuen Audience-Verarbeitungs-Backend unterstützt und bietet mehrere Verbesserungen in Bezug auf Stabilität, Robustheit und Zuverlässigkeit. Ziel dieses Leitfadens ist es, die Unterschiede zwischen der Audience API und den veralteten Prozessen zum Hochladen und Verwalten von Audiences hervorzuheben.  Referenzdokumentation ist auf der Referenzseite zur Audience API verfügbar.  Hinweis: Alle Audience-Nutzerdaten müssen vor dem Upload mit SHA-256 gehasht werden. Weitere Details, einschließlich der akzeptierten Nutzerbezeichner-Typen und der Daten-Normalisierung, finden Sie auf der Seite user data. Änderungen an der Audience-Funktionalität Die folgenden Änderungen an Custom Audiences wurden seit v4 eingeführt, und alle veralteten endpoints sind nicht mehr verfügbar, sobald v3 der Ads API eingestellt wurde:
  • Veraltet TON Upload:
    • GET accounts/:account_id/custom_audience_changes
    • GET accounts/:account_id/custom_audience_changes/:custom_audience_change_id
    • POST accounts/:account_id/custom_audience_changes
    • PUT accounts/:account_id/custom_audiences/global_opt_out
  • Veraltet Real Time Audiences:
    • POST custom_audience_memberships
  • Custom Audience:
    • Der Parameter list_type wird aus Anfrage und Antwort auf allen Custom Audience-endpoints entfernt. Dieser Parameter wurde zuvor verwendet, um den Nutzerbezeichner-Typ der Audience zu identifizieren (z. B. E-Mail, X User ID usw.). Audiences können nun jedoch mehrere Nutzerbezeichner für dieselbe Audience akzeptieren, wodurch dieser Wert irrelevant wird.
  • Allgemein:
    • Das Audience-Lookback-Fenster wurde aktualisiert, um Nutzer zu berücksichtigen, die in den letzten 90 Tagen aktiv waren (zuvor 30 Tage)
    • Die Mindestanzahl übereinstimmender Nutzer, die erforderlich ist, damit eine Audience zielbar ist, wurde auf 100 Nutzer reduziert (zuvor 500 Nutzer)
Voraussetzungen
  • Ads API-Zugang
  • Für den Zugriff auf das Audience-endpoint müssen Sie zu einer Allowlist hinzugefügt werden. Bitte füllen Sie dieses Formular aus und akzeptieren Sie die neue X Ads Products and Services Agreement, falls ursprünglich vor dem 2018-08-01 akzeptiert
Audience-Upload-Prozess Die folgende Tabelle listet die wichtigsten Unterschiede zwischen den alten und neuen Audience-Erstellungsabläufen auf; weitere Details finden Sie weiter unten:
Schritt im ProzessAudience API(Veraltet) TON Upload
Shell-Audience erstellenKann über den [POST custom_audience endpoint]/x-ads-api/audiences erstellt werdenKann über den [POST custom_audience endpoint]/x-ads-api/audiences erstellt werden
Neuen Nutzer hinzufügenVerwenden Sie operation_type Update mit dem Audience endpointVerwenden Sie operation ADD mit dem POST custom_audience_changes-endpoint
Nutzer entfernenVerwenden Sie operation_type Delete mit dem Audience endpointVerwenden Sie operation REMOVE mit dem POST custom_audience_changes-endpoint
Nutzer Opt-outVerwenden Sie operation_type Delete mit dem Audience endpoint und den entsprechenden custom_audience_ids, zu denen der Nutzer gehörtVerwenden Sie das Global opt-out endpoint
Hinweis Alle Audiences, die über den TON Upload-Pfad aktualisiert oder abgemeldet werden, müssen über das TON Upload-endpoint eine entsprechende Liste hochgeladen und einer Audience mithilfe des custom_audience_changes-endpoints zugeordnet haben. Rate Limiting Das Audience API-endpoint hat eine Rate Limit von 1500/1min pro Account. Es gibt keine Beschränkungen für die Anzahl der Nutzer, die in einer einzelnen Payload gesendet werden können. Die einzigen Einschränkungen für die Payload sind:
  1. Gesamtanzahl der Operationen: 2500 Operationen
  2. Maximale Payload-Größe: 5.000.000 Bytes
Audience-Nutzerverwaltung Um eine neue Audience zu erstellen, sind die folgenden Schritte erforderlich

Neue Custom Audience erstellen

Erstellen Sie eine neue „Hülle“ für eine Custom Audience über den endpoint [POST custom_audience]/x-ads-api/audiences und rufen Sie die entsprechende id der Custom Audience ab. Dieser Schritt ist erforderlich, wenn Sie eine Audience von Grund auf neu erstellen. Wenn Sie eine bestehende Audience aktualisieren, fahren Sie mit dem nächsten Abschnitt fort.

Nutzer zu einer Zielgruppe hinzufügen

Verwenden Sie POST accounts/:account_id/custom_audiences/:custom_audience_id/users mit der Custom-Audience-id und einer Beispielnutzlast wie folgt: POST https://ads-api.x.com/11/accounts/18ce54d4x5t/custom&#95;audiences/1nmth/users
    # Alle Werte müssen gehasht werden, ungehashte Werte werden in diesem Beispiel zu Veranschaulichungszwecken verwendet
    [
      {
        "operation_type": "Update",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "email": [
                "abc@x.com"
              ],
              "handle": [
                "x",
                "adsapi"
              ]
            },
            {
              "email": [
                "edf@x.com"
              ],
              "twitter_id": [
                "121291606",
                "17874544"
              ]
            }
          ]
        }
      }
    ]
Um einen Nutzer zu einer Audience hinzuzufügen, verwenden Sie operation_type Update. Die neue Audience-Schnittstelle ermöglicht es, mehrere Nutzer-Schlüssel für einen einzelnen Nutzer zu übergeben. Jedes Objekt im Array von JSON-Objekten entspricht einem einzelnen Nutzer. Mit dem obigen Beispiel-Payload fügt die Anfrage zwei Nutzer zu einer Audience hinzu: einen mit email und handle sowie einen weiteren mit email und twitter_id.

Nutzer aus einer Zielgruppe entfernen

Ähnlich wie beim beschriebenen Prozess zum Hinzufügen von Nutzern können Nutzer wie folgt aus einer Zielgruppe entfernt werden: POST https://ads-api.x.com/11/accounts/18ce54d4x5t/custom&#95;audiences/1nmth/users
    # Alle Werte müssen gehasht werden, ungehashte Werte werden in diesem Beispiel zu Veranschaulichungszwecken verwendet
    [
      {
        "operation_type": "Delete",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "email": [
                "abc@x.com"
              ],
              "twitter_id": [
                "783214",
                "1225933934"
              ]
            },
            {
              "email": [
                "edf@x.com"
              ],
              "twitter_id": [
                "121291606",
                "17874544"
              ]
            }
          ]
        }
      }
    ]
Der operation_type muss auf Delete gesetzt werden, und Nutzer werden anhand beliebiger Schlüssel abgeglichen, die beim Hinzufügen von Nutzern zur Zielgruppe verwendet wurden. Wenn beispielsweise ein Nutzer einer Zielgruppe mit einer email und einer twitter_id hinzugefügt wurde, kann derselbe Nutzer mit einem dieser Schlüssel entfernt werden, d. h. entweder email oder twitter_id oder beiden. Außerdem ist es möglich, innerhalb derselben Anfrage Nutzer zu einer Zielgruppe hinzuzufügen und zu entfernen. Der endpoint unterstützt mehrere operation_type pro Anfrage.

Opt-out-Nutzer

Mit der Außerkraftsetzung des globalen Opt-out-endpoints sind Partner verpflichtet, alle Nutzer per Delete zu entfernen, die sich aus beliebigen Audiences abgemeldet haben. Es gibt mehrere Möglichkeiten, dies umzusetzen:
  1. Nachverfolgen, welche Nutzer zu welchen Audiences gehören, und diese Nutzer einzeln aus jeder Audience entfernen.
  2. Den Nutzer aus allen Audiences entfernen, die einem Ads-Konto zugeordnet sind.
Allgemeine Best Practices
  • Wir empfehlen dringend, diesen endpoint in nahezu echtzeitnahen Batches aufzurufen, um Spitzen in den Warteschlangen zu vermeiden, die die Verarbeitung verzögern und generell unnötige Last auf unser System verursachen. Dies stellt außerdem sicher, dass Nutzer schneller für die Kampagnenausrichtung verfügbar sind.
  • Ein erfolgreicher API-Aufruf gibt success_count und total_count zurück, entsprechend der Anzahl der user-Objekte, die in der Anfrage übermittelt wurden.
  • Dieser endpoint ist atomar, d. h. entweder ist die gesamte Anfrage erfolgreich oder im Falle eines beliebigen Fehlers schlägt die gesamte Anfrage fehl. Bei einer Fehlermeldung wird den Nutzern der API empfohlen, den Fehler zu beheben und die Anfrage mit der vollständigen Nutzlast erneut zu senden.
  • Im Fehlerfall wird Partnern empfohlen, einen Ansatz mit exponentiellem Backoff und Wiederholungen zu verwenden. Beispiel: sofort nach dem ersten Fehler erneut versuchen, nach 1 Minute nach dem zweiten Fehler und nach 5 Minuten nach dem dritten aufeinanderfolgenden Fehler erneut versuchen usw.

API-Referenz

Keyword-Einblicke

GET insights/keywords/search

Für eine Gruppe von Keywords rufen Sie das zugehörige Tweet-Volumen sowie einen Satz von 30 verwandten Keywords ab. Das Tweet-Volumen bezieht sich ausschließlich auf die eingegebenen Keywords, nicht auf die verwandten Keywords. Ein maximaler Zeitraum (end_time - start_time) von 7 Tagen ist zulässig. Bitte beachten Sie, dass die Ergebnisse auf ein einzelnes Geo (Land) beschränkt sind. Resource URL https://ads-api.x.com/12/insights/keywords/search Parameters
NameDescription
granularity
required
Gibt die Granularität der für den durch start_time und end_time definierten Zeitraum zurückgegebenen data an. Wenn beispielsweise auf HOUR gesetzt, erhalten Sie für jede Stunde zwischen start_time und end_time einen Datenpunkt.

Type: enum

Possible values: DAY, HOUR
keywords
required
Eine kommagetrennte Zeichenfolge von Keywords zur Einschränkung der Suche. Alle Keywords werden mit ODER verknüpft.

Hinweis: Es können maximal 10 Keywords (kombiniert aus keywords und negative_keywords) verwendet werden.

Type: string

Example: developers
start_time
required
Beschränkt die abgerufenen data auf data, die innerhalb des Zeitfensters zwischen start_time und end_time gesammelt wurden. Ausgedrückt in ISO 8601.

Type: string

Example: 2017-07-10T00:00:00Z
end_time
optional
Beschränkt die abgerufenen data auf data, die innerhalb des Zeitfensters zwischen start_time und end_time gesammelt wurden. Ausgedrückt in ISO 8601.

Hinweis: Standardmäßig die aktuelle Uhrzeit.

Type: string

Example: 2017-07-11T00:00:00Z
location
optional
Ein Targeting-Wert, den Sie vom endpoint GET targeting_criteria/locations erhalten, um Ergebnisse nach dem Standort des Kontobenutzers einzugrenzen. Beachten Sie, dass derzeit nur Standorte auf Länderebene unterstützt werden.

Type: string

Example: 0ce8b9a7b2742f7e
negative_keywords
optional
Eine kommagetrennte Zeichenfolge von auszuschließenden Keywords. Alle negativen Keywords werden mit ODER verknüpft.

Hinweis: Es können maximal 10 Keywords (kombiniert aus keywords und negative_keywords) verwendet werden.

Type: string

Example: rain
Example Request
GET https://ads-api.x.com/12/insights/keywords/search?end_time=2018-02-02&granularity=DAY&keywords=developers&start_time=2018-02-01
Beispielantwort*
    {
      "request": {
        "params": {
          "start_time": "2018-02-01T00:00:00Z",
          "end_time": "2018-02-02T00:00:00Z",
          "granularity": "DAY",
          "keywords": [
            "developers"
          ]
        }
      },
      "data": {
        "related_keywords": [
          "dev",
          "developer",
          "coders",
          "mysql",
          "devs",
          "#technology",
          "#developers",
          "security",
          "programmers",
          "#tech",
          "javascript",
          "#iot",
          "#bigdata",
          "cloud",
          "devops",
          "php",
          "developer",
          "programmer",
          "engineer",
          "big data",
          "agile",
          "app",
          "programming",
          "ios",
          "maker",
          "startups",
          "developer's",
          "java",
          "#devops",
          "startup"
        ],
        "tweet_volume": [
          15707
        ]
      }
    }

Berechtigungen für Tailored Audiences

GET accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

Ruft Details zu einigen oder allen Berechtigungen ab, die der angegebenen Tailored Audience zugeordnet sind. Resource URL https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions Parameters
NameBeschreibung
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
tailored_audience_id
erforderlich
Ein Verweis auf die Tailored Audience, mit der Sie in der Anfrage arbeiten.

Type: string

Example: 1nmth
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
granted_account_ids
optional
Beschränkt die Antwort auf die gewünschten Konten, indem eine kommagetrennte Liste von Bezeichnern angegeben wird. Es können bis zu 200 IDs angegeben werden.

Type: string

Example: 18ce54aymz3
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
tailored_audience_permission_ids
optional
Beschränkt die Antwort auf die gewünschten Berechtigungen der Tailored Audience, indem eine kommagetrennte Liste von Bezeichnern angegeben wird. Es können bis zu 200 IDs angegeben werden.

Type: string

Example: ri
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 festgelegt auf 200 pro 15 Minuten.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "tailored_audience_id": "1nmth"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "tailored_audience_id": "1nmth",
          "permission_level": "READ_ONLY",
          "id": "ri",
          "created_at": "2017-06-08T23:17:59Z",
          "granted_account_id": "18ce54aymz3",
          "updated_at": "2017-06-08T23:17:59Z",
          "deleted": false
        }
      ]
    }

POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

Erstellen Sie ein neues Berechtigungsobjekt, mit dem die angegebene Zielgruppe mit einem bestimmten Konto geteilt werden kann. Hinweis: Zum Erstellen oder Ändern von Berechtigungen für eine maßgeschneiderte Zielgruppe muss die Zielgruppe dem Konto gehören, das die Berechtigungen ändern möchte. Sie können die Eigentümerschaft einer maßgeschneiderten Zielgruppe prüfen, indem Sie das Antwortattribut is_owner in der Antwort für die entsprechende Zielgruppe betrachten. Hinweis: Zielgruppen können nur zwischen Werbekonten desselben Unternehmens geteilt werden oder wenn das Werbekonto, dem die Zielgruppe gehört, das Kontofeature SHARE_AUDIENCE_OUTSIDE_BUSINESS hat. Resource URL https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions Parameters
NameDescription
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
granted_account_id
erforderlich
Das Konto, dem Sie Berechtigungen für die maßgeschneiderte Zielgruppe erteilen möchten.

Typ: string

Beispiel: 18ce54aymz3
permission_level
erforderlich
Die Art des Zugriffs auf die maßgeschneiderte Zielgruppe, die granted_account_id erhalten soll.

Typ: enum

Mögliche Werte: READ_ONLY, READ_WRITE
tailored_audience_id
erforderlich
Ein Verweis auf die maßgeschneiderte Zielgruppe, mit der Sie in der Anfrage arbeiten.

Typ: string

Beispiel: 2906h
Example Request POST https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "granted_account_id": "18ce54aymz3",
          "permission_level": "READ_ONLY",
          "tailored_audience_id": "2906h"
        }
      },
      "data": {
        "tailored_audience_id": "2906h",
        "permission_level": "READ_ONLY",
        "id": "14m",
        "created_at": "2017-09-12T23:49:34Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-09-12T23:49:34Z",
        "deleted": false
      }
    }

DELETE accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id

Widerruft die angegebene Freigabeberechtigung für eine Tailored Audience. Hinweis: Das Erstellen oder Ändern von Berechtigungen für eine Tailored Audience setzt voraus, dass die Audience dem Konto gehört, das die Berechtigungen ändern möchte. Sie können die Eigentümerschaft einer Tailored Audience prüfen, indem Sie das Antwortattribut is_owner in der Antwort für eine bestimmte Audience betrachten. Nach dem Widerruf garantieren wir, dass das berechtigte Konto (granted_account_id) die Audience in zukünftigen Kampagnen nicht mehr ansprechen kann. Bestehende Kampagnen laufen weiterhin mit den freigegebenen Audiences; Kampagnen werden nicht gestoppt und die Audience wird nicht aus der Kampagne entfernt. Es ist nicht möglich, diese Kampagne zu kopieren, nachdem die Freigabeberechtigung für die Audience widerrufen wurde. Resource URL https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id Parameters
NameBeschreibung
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 Nutzer zugeordnet sein.

Typ: string

Beispiel: 18ce54d4x5t
tailored_audience_id
erforderlich
Referenz auf die Tailored Audience, mit der Sie in der Anfrage arbeiten.

Typ: string

Beispiel: 1nmth
tailored_audience_permission_id
erforderlich
Referenz auf die Berechtigung für die Tailored Audience, mit der Sie in der Anfrage arbeiten.

Typ: string

Beispiel: ri
Example Request DELETE https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions/ri Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "tailored_audience_permission_id": "ri",
          "tailored_audience_id": "1nmth"
        }
      },
      "data": {
        "tailored_audience_id": "1nmth",
        "permission_level": "READ_ONLY",
        "id": "ri",
        "created_at": "2017-06-08T23:17:59Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-08-30T18:29:35Z",
        "deleted": true
      }
    }

Zielgruppen

GET accounts/:account_id/custom_audiences/:custom_audience_id/targeted

Ruft eine Liste aktiver oder aller Line Items und Kampagnen ab, die eine angegebene custom_audience_id anvisieren
NameBeschreibung
account_id
erforderlich
Der Bezeichner für das verwendete Konto. 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.

Typ: string

Beispiel: 18ce54d4x5t
custom_audience_id
erforderlich
Eine Referenz auf die Custom Audience, mit der Sie in der Anfrage arbeiten.

Typ: string

Beispiel: 2906h
with_active
optional
Wenn false, werden auch Line Items mit dem Status servable=false einbezogen

Typ: boolean

Standard: true
Mögliche Werte: true, false
cursor
optional
Gibt einen Cursor an, um die nächste Seite der Ergebnisse abzurufen. Siehe Pagination für weitere Informationen.

Typ: string

Beispiel: 8x7v00oow
Beispielanfrage GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h/targeted Beispielantwort
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_id": "2906h",
        }
      },
      "next_cursor": null,
      "data": [
        {
          "campaign_id": "59hod",
          "campaign_name": "Test-Kampagne",
          "line_items": [
            {
              "id": "5gzog",
              "name": "Test-Werbeanzeigengruppe",
              "servable": true
            }
          ]
        },
        {
          "campaign_id": "arja7",
          "campaign_name": "Unbenannte Kampagne",
          "line_items": [
            {
              "id": "bjw1q",
              "name": null,
              "servable": true
            }
          ]
        }
      ]
    }

Nutzer in Custom Audiences

POST accounts/:account_id/custom_audiences/:custom_audience_id/users

Dieses Endpoint ermöglicht Partnern, Nutzer für eine angegebene custom_audience_id hinzuzufügen, zu aktualisieren und zu entfernen. Das Endpoint akzeptiert zudem mehrere Nutzer-Identifikatortypen pro Nutzer. Alle in dem users-Feld der Anfrage bereitgestellten data — außer partner_user_id — müssen mit SHA256 gehasht und normalisiert werden. Batch-Anfragen
  • Die aktuelle maximale Batchgröße beträgt 2500 für dieses Endpoint. Die Batchgröße wird durch die Anzahl der Operationen (Update/Delete) pro Anfrage bestimmt. Beispielsweise führen mehr als 2500 Operationsobjekte ({"operation_type": "Update/Delete", [..] }) in einem Array zu einem Fehler.
  • Die maximale Größe des POST-Request-Bodys, die dieses Endpoint akzeptieren kann, beträgt 5,000,000 Bytes.
  • Die Rate Limits für dieses Endpoint betragen 1500 pro 1-Minuten-Fenster.
  • Alle Parameter werden im Request-Body gesendet, und ein Content-Type von application/json ist erforderlich.
  • Batch-Anfragen schlagen als Gruppe gemeinsam fehl oder sind gemeinsam erfolgreich, und alle API-Antworten bewahren bei Fehlern wie auch bei Erfolg die Elementreihenfolge der ursprünglichen Anfrage.
Batch-Antworten Die von der Ads API zurückgegebene Antwort enthält zwei fields: success_count und total_count. Diese Werte müssen stets gleich sein; sie geben die Anzahl der Datensätze in der Anfrage an, die vom Backend verarbeitet wurden. Eine Situation, in der die Anzahl der im Request-Body gesendeten Datensätze nicht success_count und total_count entspricht, ist als Fehlerzustand zu behandeln und erfordert einen erneuten Versuch. Batch-Fehler
  • Fehler auf Anfrageebene (z. B. maximale Batchgröße überschritten) werden in der Antwort unter dem Objekt errors angezeigt.
  • Fehler auf Elementebene (z. B. fehlende erforderliche Parameter) werden in der Antwort unter dem Objekt operation_errors angezeigt.
  • Der Index des Fehlers in operation_errors bezieht sich auf den Index des Eingabeelements, mit der entsprechenden Fehlermeldung.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/users

Parameter

NameDescription
operation_type
required
Der pro users-Gruppe ausgeführte Operationstyp.

Type: enum

Possible values: Update, Delete
params
required
Ein JSON-Objekt, das das Array users sowie die Zeitstempel effective_at und expires_at enthält.

Type: JSON
users
required
Ein Array von JSON-Objekten mit allen Parametern für einen einzelnen Nutzer.

Type: JSON
effective_at
optional
Die UTC-Zeit, zu der die Zuordnung(en) zur benutzerdefinierten Zielgruppe wirksam werden soll(en). Ausgedrückt in ISO 8601. Standardmäßig aktuelles Datum und Uhrzeit.

Type: string

Example: 2017-07-05T07:00:00Z
expires_at
optional
Die UTC-Zeit, zu der die Zuordnung(en) zur benutzerdefinierten Zielgruppe ablaufen soll(en). Die angegebene Zeit muss später sein als der Wert von effective_at. Ausgedrückt in ISO 8601. Standardmäßig 13 Monate ab dem Zeitstempel der Anfrage.

Type: string

Example: 2017-07-05T07:00:00Z
Angesichts des Multi-Key-Ansatzes für das Objekt users wird jedes Element dieses Objekts unten dokumentiert:
NameDescription
email
optional
E-Mail-Adresse(n) des Nutzers.

Type: Array[String]
device_id
optional
IDFA/AdID/Android-ID

Type: Array[String]
handle
optional
Die @Handle(s), die zum Nutzer gehören

Type: Array[String]
twitter_id
optional
Die X-ID des Nutzers

Type: Array[String]
phone_number
optional
Telefonnummer(n) des Nutzers

Type: Array[String]
partner_user_id
optional
Die Nutzer-ID im System des Partners.

Type: Array[String]

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/users
    [
      {
        "operation_type": "Update",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "email": [
                "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
              ],
              "handle": [
                "7352f353c460e74c7ae226952d04f8aa307b12329c5512ec8cb6f1a0f8f9b2cb",
                "49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d"
              ]
            },
            {
              "email": [
                "5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
              ],
              "twitter_id": [
                "34d56c7159a7eea941f359653029410f813f65a1d2d13ecc5ccbdd5a8cb755cf",
                "00e7b76c9739dec57f4c4a20ec021a20ffcf26bd00f519b17ea00f0ed6048f85"
              ]
            }
          ]
        }
      },
      {
        "operation_type": "Delete",
        "params": {
          "effective_at": "2018-05-15T00:00:00Z",
          "expires_at": "2019-01-01T07:00:00Z",
          "users": [
            {
              "device_id": [
                "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
              ],
              "email": [
                "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
              ],
              "handle": [
                "461222f5dd690a20651c3d19848015cb0369db3f8e937571ffb775de70750847"
              ],
              "twitter_id": [
                "c623c7e163984493b46c547088542e95d0aaa529bc52bbecce3ff91eb6b7843b"
              ]
            },
            {
              "email": [
                "5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
              ],
              "twitter_id": [
                "858cdc7f313f84a3f3c48e9a6323307c1ef1bb7439b8e3623e140454b0fd8fa5",
                "bb074e154657b91d99bd1bb3757409149670e8ae7a0fe9136fae29a26a7881c8"
              ]
            }
          ]
        }
      }
    ]

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_id": "1nmth"
        }
      },
      "data": {
        "success_count": 4,
        "total_count": 4
      }
    }

Berechtigungen für Custom Audiences

GET accounts/:account_id/custom_audiences/:custom_audience_id/permissions

Rufen Sie Details zu einigen oder allen Berechtigungen ab, die der angegebenen Custom Audience zugeordnet sind. Resource URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions Parameters
NameBeschreibung
account_id
required
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
custom_audience_id
required
Ein Verweis auf die Custom Audience, mit der Sie in der Anfrage arbeiten.

Type: string

Example: 1nmth
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 Seite der Ergebnisse abzurufen. Siehe Pagination für weitere Informationen.

Type: string

Example: 8x7v00oow
granted_account_ids
optional
Beschränken Sie die Antwort auf die gewünschten Konten, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden.

Type: string

Example: 18ce54aymz3
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
custom_audience_permission_ids
optional
Beschränken Sie die Antwort auf die gewünschten Berechtigungen der Custom Audience, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden.

Type: string

Example: ri
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 festgelegt auf 200 pro 15 Minuten.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/permissions Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_id": "1nmth"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "custom_audience_id": "1nmth",
          "permission_level": "READ_ONLY",
          "id": "ri",
          "created_at": "2017-06-08T23:17:59Z",
          "granted_account_id": "18ce54aymz3",
          "updated_at": "2017-06-08T23:17:59Z",
          "deleted": false
        }
      ]
    }

POST accounts/:account_id/custom_audiences/:custom_audience_id/permissions

Erstellt ein neues Berechtigungsobjekt, mit dem die angegebene Zielgruppe mit einem bestimmten Konto geteilt werden kann. Hinweis: Zum Erstellen oder Ändern von Berechtigungen für eine benutzerdefinierte Zielgruppe muss die Zielgruppe dem Konto gehören, das die Berechtigungen ändern möchte. Sie können die Inhaberschaft einer benutzerdefinierten Zielgruppe prüfen, indem Sie das Antwortattribut is_owner in der Antwort für die betreffende Zielgruppe betrachten. Hinweis: Zielgruppen können nur zwischen Anzeigenkonten desselben Unternehmens geteilt werden oder wenn das Anzeigenkonto, dem die Zielgruppe gehört, die Konto-Funktion SHARE_AUDIENCE_OUTSIDE_BUSINESS hat. Resource URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions Parameters
NameBeschreibung
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 Nutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
granted_account_id
erforderlich
Das Konto, dem Sie Berechtigungen für die benutzerdefinierte Zielgruppe erteilen möchten.

Type: string

Example: 18ce54aymz3
permission_level
erforderlich
Die Art des Zugriffs auf die benutzerdefinierte Zielgruppe, den granted_account_id erhalten soll.

Type: enum

Possible values: READ_ONLY, READ_WRITE
custom_audience_id
erforderlich
Ein Verweis auf die benutzerdefinierte Zielgruppe, mit der Sie in der Anfrage arbeiten.

Type: string

Example: 2906h
Example Request
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY
Beispielantwort
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "granted_account_id": "18ce54aymz3",
          "permission_level": "READ_ONLY",
          "custom_audience_id": "2906h"
        }
      },
      "data": {
        "custom_audience_id": "2906h",
        "permission_level": "READ_ONLY",
        "id": "14m",
        "created_at": "2017-09-12T23:49:34Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-09-12T23:49:34Z",
        "deleted": false
      }
    }

DELETE accounts/:account_id/custom_audiences/:custom_audience_id/permissions/:custom_audience_permission_id

Widerrufen Sie die angegebene Freigabeberechtigung für die Custom Audience. Hinweis: Das Erstellen oder Ändern von Berechtigungen für eine Custom Audience setzt voraus, dass die Audience dem Konto gehört, das die Berechtigungen ändern möchte. Sie können die Inhaberschaft einer Custom Audience prüfen, indem Sie das Antwortattribut is_owner in der Antwort für die betreffende Audience heranziehen. Nach dem Widerruf garantieren wir, dass das berechtigte Konto (granted_account_id) die Audience in zukünftigen Kampagnen nicht mehr targeten kann. Bestehende Kampagnen laufen mit den freigegebenen Audiences weiter; Kampagnen werden nicht gestoppt und die Audience wird nicht aus der Kampagne entfernt. Es ist nicht möglich, diese Kampagne zu kopieren, nachdem die Freigabeberechtigung für die Audience widerrufen wurde. Resource-URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions/:custom_audience_permission_id Parameter
NameBeschreibung
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 Nutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
custom_audience_id
erforderlich
Ein Verweis auf die Custom Audience, mit der Sie in der Anfrage arbeiten.

Type: string

Example: 1nmth
custom_audience_permission_id
erforderlich
Ein Verweis auf die Berechtigung der Custom Audience, mit der Sie in der Anfrage arbeiten.

Type: string

Example: ri
Beispielanfrage DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/permissions/ri Beispielantwort
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "custom_audience_permission_id": "ri",
          "custom_audience_id": "1nmth"
        }
      },
      "data": {
        "custom_audience_id": "1nmth",
        "permission_level": "READ_ONLY",
        "id": "ri",
        "created_at": "2017-06-08T23:17:59Z",
        "granted_account_id": "18ce54aymz3",
        "updated_at": "2017-08-30T18:29:35Z",
        "deleted": true
      }
    }

Custom Audiences

GET accounts/:account_id/custom_audiences

Rufen Sie Details für einige oder alle Custom Audiences ab, die dem aktuellen Account zugeordnet sind. Resource-URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences Parameter
NameBeschreibung
account_id
erforderlich
Der Bezeichner für den verwendeten Account. Er erscheint im Ressourcenpfad und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Der angegebene Account muss dem authentifizierten Benutzer zugeordnet sein.

Typ: string

Beispiel: 18ce54d4x5t
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
permission_scope
optional
Ermöglicht das Filtern der Antwort auf Listen, die Ihnen gehören, oder Listen, die mit Ihnen geteilt wurden. Ohne Angabe dieses Parameters sehen Sie standardmäßig nur Audiences, die Ihnen gehören.

Typ: enum

Standard: OWNER
Mögliche Werte: OWNER, SHARED
q
optional
Eine optionale Abfrage, um die Ressource nach name einzugrenzen.

Hinweis: Es wird eine Groß-/Kleinschreibung ignorierende Präfixübereinstimmung durchgeführt.

Typ: string

Min-, Max-Länge: 1, 255
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
custom_audience_ids
optional
Beschränken Sie die Antwort auf die gewünschten Custom Audiences, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übermittelt werden.

Typ: string

Beispiel: 1nmth
with_deleted
optional
Schließen Sie gelöschte Ergebnisse in Ihre 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
Beispielanfrage GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences?custom_audience_ids=1nmth Beispielantwort
    {
      "request": {
        "params": {
          "custom_audience_ids": [
            "1nmth"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "targetable": true,
          "name": "twurl-using-subshell-for-file",
          "targetable_types": [
            "CRM",
            "EXCLUDED_CRM"
          ],
          "audience_type": "CRM",
          "description": null,
          "permission_level": "READ_WRITE",
          "owner_account_id": "18ce54d4x5t",
          "id": "1nmth",
          "reasons_not_targetable": [],
          "created_at": "2017-01-08T08:19:58Z",
          "updated_at": "2017-01-08T16:21:13Z",
          "partner_source": "OTHER",
          "deleted": false,
          "audience_size": 1470
        }
      ]
    }

GET accounts/:account_id/custom_audiences/:custom_audience_id

Rufen Sie spezifische Custom Audiences ab, die dem aktuellen Account zugeordnet sind. Resource URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id Parameters
NameDescription
account_id
erforderlich
Der Bezeichner für den genutzten Account. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Der angegebene Account muss dem authentifizierten Benutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
custom_audience_id
erforderlich
Ein Verweis auf die Custom Audience, mit der Sie in der Anfrage arbeiten.

Type: string

Example: 2906h
with_deleted
optional
Gelöschte Ergebnisse in die Anfrage einbeziehen.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h Example Response
    {
      "request": {
        "params": {
          "custom_audience_id": "2906h",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "targetable": false,
        "name": "developers",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM",
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "owner_account_id": "18ce54d4x5t",
        "id": "2906h",
        "reasons_not_targetable": [],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-22T23:34:26Z",
        "partner_source": "OTHER"
        "deleted": false,
        "audience_size": 140321
      }
    }

POST accounts/:account_id/custom_audiences

Erstellen Sie eine neue Platzhalter-Custom Audience, die dem aktuellen Account zugeordnet ist. Resource URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences Parameters
NameDescription
account_id
required
Der Bezeichner für den verwendeten Account. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Der angegebene Account muss dem authentifizierten Nutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
name
required
Der Anzeigename für diese Audience. Es muss ein eindeutiger Name verwendet werden; andernfalls wird ein Fehler zurückgegeben.

Type: string

Example: ads api users
description
optional
Eine Beschreibung für diese Audience.

Type: string

Example: Collection of all users of the Ads API
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences?name=developers Example Response
    {
      "data": {
        "targetable": false,
        "name": "developers",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM"
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "owner_account_id": "18ce54d4x5t",
        "id": "2906h",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL",
        ],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-22T23:34:26Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": null
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "name": "developers"
        }
      }
    }

PUT accounts/:account_id/custom_audiences/:custom_audience_id

Aktualisiert die spezifische Custom Audience, die dem aktuellen Konto zugeordnet ist. Resource URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id Parameters
NameDescription
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 Nutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
custom_audience_id
erforderlich
Referenz auf die Custom Audience, mit der in der Anfrage gearbeitet wird.

Type: string

Example: 2906h
name
optional
Der Anzeigename für diese Audience. Es muss ein eindeutiger Name verwendet werden, andernfalls wird ein Fehler zurückgegeben.

Type: string

Example: ads api users
description
optional
Eine Beschreibung für diese Audience.

Type: string

Example: Collection of all users of the Ads API
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h?name=developers_changed Example Response
    {
      "data": {
        "targetable": false,
        "name": "developers_changed",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM"
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "is_owner": true,
        "id": "2906h",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-22T23:34:26Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": null
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "name": "developers_changed"
        }
      }
    }

POST batch/accounts/:account_id/custom_audiences

Ermöglicht die Batch-Erstellung von Custom Audiences. Siehe die Seite Custom Audiences Overview für Informationen zu Audiences. Hinweis: Dieses Batch-endpoint befindet sich derzeit in einer Closed Beta und ist für ausgewählte Werbetreibende verfügbar. Während dieses Beta-Zeitraums können nur Flexible Audiences auf Basis mobiler Custom Audiences erstellt werden. Batch-Anfragen
  • Die aktuelle maximale Batch-Größe beträgt 10.
  • Alle Parameter werden im Request Body gesendet, und ein Content-Type von application/json ist erforderlich.
  • Batch-Anfragen schlagen gemeinsam fehl oder sind gemeinsam erfolgreich, und alle API-Antworten für Fehler und Erfolg bewahren die Reihenfolge der Elemente aus der ursprünglichen Anfrage.
Batch-Antworten Batch-API-Antworten liefern eine geordnete Sammlung von Elementen. Ansonsten sind sie in ihrer Struktur mit den entsprechenden Single-Item-Endpoints identisch. Batch-Fehler
  • Fehler auf Anfrageebene (z. B. maximale Batch-Größe überschritten) werden in der Antwort unter dem Objekt errors angezeigt.
  • Fehler auf Elementebene (z. B. erforderlicher Parameter fehlt) werden in der Antwort unter dem Objekt operation_errors angezeigt.
Flexible Audiences
  • Flexible Audiences sind nach der Erstellung unveränderlich.
  • Custom Audiences werden in einer Baumstruktur mit boolescher Logik kombiniert, um Flexible Audiences zu erstellen.
  • Es können maximal 10 Blattknoten von Custom Audiences verwendet werden, um eine Flexible Audience zu erstellen.
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/custom_audiences Parameters
NameBeschreibung
account_id
erforderlich
Der Bezeichner für das verwendete Konto. 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.

Typ: string

Beispiel: 18ce54d4x5t
audience_type
erforderlich
Der Typ der zu erstellenden Audience.

Typ: enum

Mögliche Werte: FLEXIBLE, MOBILE_AUDIENCE
child_segments
erforderlich
Ein Array mit Objekten, die die Teilmenge der Mitglieder einer Custom Audience definieren, die Sie targeten möchten. Jedes Objekt sollte eine custom_audience_id, frequency, frequency_comparator, lookback_window, negate und in einigen Fällen zusätzliche child_segments enthalten.

Typ: array
name
erforderlich
Der Anzeigename für die Audience. Es muss ein eindeutiger Name verwendet werden. Andernfalls wird ein Fehler ausgegeben.

Typ: string

Beispiel: my_flexible_audience_name
operation_type
erforderlich
Der auf das einzelne Element angewendete Operationstyp.

Typ: enum

Mögliche Werte: Create, Update, Delete
boolean_operator
manchmal erforderlich
Die logische Beziehung zwischen den Child-Segmenten im übergeordneten (enthaltenden) Objekt. Erforderlich, wenn child_segments für das übergeordnete Objekt nicht leer ist.

Typ: enum

Mögliche Werte: AND, OR
lookback_window
manchmal erforderlich
Ein ganzzahliger Wert, der den Zeitraum in Tagen angibt, innerhalb dessen der Benutzer die spezifische Aktion ausgeführt und sich für die angegebene Custom Audience qualifiziert hat.

Typ: int

Mögliche Werte: 1, 7, 14, 30
segments
manchmal erforderlich
Ein Objekt, das einen boolean_operator und child_segments enthält, die die Teilmenge der Mitglieder einer Custom Audience definieren, die Sie targeten möchten.

Typ: object
custom_audience_id
manchmal erforderlich
Die id der als Child-Segment zu verwendenden Custom Audience.

Typ: string

Beispiel: tyfo
frequency
optional
Ein ganzzahliger Wert, der die Häufigkeit innerhalb des Lookback-Zeitraums angibt, mit der der Benutzer die spezifische Aktion ausgeführt und sich für die angegebene Custom Audience qualifiziert hat.

Typ: int

Standardwert: 1
frequency_comparator
optional
Der Vergleichsoperator zur in der Anfrage übergebenen frequency.

Hinweis: In den folgenden Werten steht GTE für größer oder gleich, LT für kleiner als usw.

Typ: string

Mögliche Werte: NUM_GTE, NUM_GT, NUM_EQ, NUM_LTE, NUM_LT Standardwert: NUM_GTE
negate
optional
Negiert das Segment und schließt es dadurch in der Kombination aus.

Typ: boolean

Standardwert: true
Mögliche Werte: true, false
Beispielanfrage POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/custom_audiences
    [
      {
        "operation_type":"Create",
        "params":{
          "name":"mein_flexible_audience_name",
          "audience_type":"FLEXIBLE",
          "segments":{
            "boolean_operator":"AND",
            "child_segments":[
              {
                "custom_audience_id":"TYIF",
                "frequency":1,
                "frequency_comparator":"NUM_GT",
                "lookback_window":30,
                "negate":true,
                "child_segments":[

                ]
              },
              {
                "boolean_operator":"OR"
                "child_segments":[
                  {
                    "custom_audience_id":"TXR1",
                    "lookback_window":30,
                    "child_segments":[

                    ]
                  },
                  {
                    "custom_audience_id":"TYFO",
                    "frequency":1,
                    "frequency_comparator":"NUM_GT",
                    "lookback_window":30,
                    "negate":true,
                    "child_segments":[

                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    ]
Beispielantwort
    {
      "data": {
        "targetable": false,
        "name": "mein_flexibler_zielgruppenname",
        "targetable_types": [
          "FLEXIBLE",
          "EXCLUDED_FLEXIBLE"
        ],
        "audience_type": "FLEXIBLE",
        "id": "13ld7",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "metadata": [
          {
            "custom_audience_id": "13ld7",
            "account_id": "qsx3w2",
            "name": "mein_flexibler_zielgruppenname",
            "audience_source": "FLEXIBLE_AUDIENCE",
            "upload_status": "UPLOADED",
            "segments": {
              "boolean_operator": "AND",
              "frequency": 1,
              "frequency_comparator": "NUM_GTE",
              "negate": false,
              "child_segments": [
                {
                  "custom_audience_id": "tyif",
                  "lookback_window": 30,
                  "frequency": 1,
                  "frequency_comparator": "NUM_GT",
                  "negate": true,
                  "child_segments": [

                  ]
                },
                {
                  "boolean_operator": "OR",
                  "frequency": 1,
                  "frequency_comparator": "NUM_GTE",
                  "negate": false,
                  "child_segments": [
                    {
                      "custom_audience_id": "txr1",
                      "lookback_window": 30,
                      "frequency": 1,
                      "frequency_comparator": "NUM_GTE",
                      "negate": false,
                      "child_segments": [

                      ]
                    },
                    {
                      "custom_audience_id": "tyfo",
                      "lookback_window": 30,
                      "frequency": 1,
                      "frequency_comparator": "NUM_GT",
                      "negate": true,
                      "child_segments": [

                      ]
                    }
                  ]
                }
              ]
            }
          }
        ],
        "created_at": "2015-11-10T21:26:43Z",
        "updated_at": "2015-11-11T01:11:47Z",
        "partner_source": "OTHER",
        "deleted": false,
        "audience_size": null
      },
      "request": [
        {
          "params": {
            "name": "mein_flexibler_zielgruppenname",
            "audience_type": "FLEXIBLE",
            "segments": {
              "boolean_operator": "AND",
              "child_segments": [
                {
                  "custom_audience_id": "TYIF",
                  "lookback_window": 30,
                  "frequency": 1,
                  "frequency_comparator": "NUM_GT",
                  "negate": true,
                  "child_segments": [

                  ]
                },
                {
                  "boolean_operator": "OR",
                  "child_segments": [
                    {
                      "custom_audience_id": "TXR1",
                      "lookback_window": 30,
                      "child_segments": [

                      ]
                    },
                    {
                      "custom_audience_id": "TYFO",
                      "lookback_window": 30,
                      "frequency": 1,
                      "frequency_comparator": "NUM_GT",
                      "negate": true,
                      "child_segments": [

                      ]
                    }
                  ]
                }
              ]
            },
            "account_id": "qsx3w2"
          },
          "operation_type": "Create"
        }
      ]
    }

DELETE accounts/:account_id/custom_audiences/:custom_audience_id

Löscht die angegebene Custom Audience, die dem aktuellen Account zugeordnet ist. Resource URL https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id Parameters
NameDescription
account_id
required
Der Bezeichner des genutzten Accounts. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen, mit Ausnahme von GET accounts. Der angegebene Account muss dem authentifizierten Benutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
custom_audience_id
required
Ein Verweis auf die Custom Audience, mit der diese Anfrage arbeitet.

Type: string

Example: 2906h
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h Example Response
    {
      "data": {
        "targetable": false,
        "name": "developers",
        "targetable_types": [
          "CRM",
          "EXCLUDED_CRM",
        ],
        "audience_type": "CRM",
        "description": null,
        "permission_level": "READ_WRITE",
        "owner_account_id": "18ce54d4x5t",
        "id": "2906h",
        "reasons_not_targetable": [
          "TOO_SMALL"
        ],
        "created_at": "2017-08-22T23:34:26Z",
        "updated_at": "2017-08-30T18:09:00Z",
        "partner_source": "OTHER",
        "deleted": true,
        "audience_size": null
      },
      "request": {
        "params": {
          "custom_audience_id": "2906h",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Do-not-reach-Listen

GET accounts/:account_id/do_not_reach_lists

Rufen Sie Details für einige oder alle Do Not Reach Lists ab, die dem aktuellen Account zugeordnet sind. Hinweis: Eine account_id kann höchstens eine Do Not Reach List haben. Resource URL https://ads-api.x.com/12/accounts/:account_id/do_not_reach_lists Parameters
NameDescription
account_id
required
Der Bezeichner für das genutzte Account. 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 Account muss dem authentifizierten Benutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
with_deleted
optional
Gelöschte Ergebnisse in die Anfrage einschließen.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54bgxky"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "targetable": false,
          "name": "Nicht-kontaktieren-Liste",
          "description": "Test-DNRL",
          "id": "4kzrq",
          "reasons_not_targetable": [
            "ZU KLEIN"
          ],
          "created_at": "2021-10-28T22:09:29Z",
          "list_size": null,
          "updated_at": "2021-11-04T03:33:06Z",
          "deleted": false
        }
      ]
    }

POST accounts/:account_id/do_not_reach_lists

Erstellen Sie eine neue Do Not Reach List, die dem aktuellen Konto zugeordnet ist. Hinweis: Ein account_id kann höchstens eine Do Not Reach List haben Resource URL https://ads-api.x.com/12/accounts/:account_id/do_not_reach_lists Parameters
NameBeschreibung
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 Nutzer zugeordnet sein.

Typ: string

Beispiel: 18ce54d4x5t
description
optional
Eine Beschreibung für diese Zielgruppe.

Typ: string

Beispiel: A list of users to exclude
Example Request POST https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists?description=A list of users to exclude Example Response
    {
      "request": {
        "params": {
          "description": "Liste der auszuschließenden Nutzer",
          "account_id": "18ce54bgxky"
        }
      },
      "data": {
        "targetable": false,
        "name": "Nicht-kontaktieren-Liste",
        "description": "Liste der auszuschließenden Nutzer"
        "id": "4ofrq",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2022-02-08T23:02:48Z",
        "list_size": null,
        "updated_at": "2022-02-08T23:02:48Z",
        "deleted": false
      }
    }

POST batch/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id/users

Dieses endpoint ermöglicht es, Nutzer zu einer bestimmten do_not_reach_list_id hinzuzufügen, zu aktualisieren und zu entfernen. Dieses endpoint akzeptiert nur E-Mail-Adressen als gültigen Nutzer-Identifikatortyp. Alle im Feld emails der Anfrage bereitgestellten Daten müssen mit SHA256 gehasht und normalisiert werden. Hinweise
  • Eine account_id kann höchstens eine Do Not Reach List haben
  • Nutzer, die zu dieser Liste hinzugefügt werden, müssen einen expires_at-Zeitstempel haben, der weniger als 13 Monate ab dem aktuellen Zeitstempel in der Zukunft liegt
  • Die Do Not Reach List API akzeptiert keinen effective_at-Zeitstempel und verwendet standardmäßig den aktuellen Zeitstempel
  • Die Do Not Reach List entfernt keine Nutzer aus einzelnen oder allen benutzerdefinierten Zielgruppen im Konto, sondern dient als Ausschluss-Targeting für alle Kampagnen, die für das Konto ausgeliefert werden
Batch-Anfragen
  • Die aktuelle maximale Batch-Größe beträgt 2500 für dieses endpoint. Die Batch-Größe wird durch die Anzahl der Operationen (Update/Delete) pro Anfrage bestimmt. Beispielsweise führen mehr als 2500 Operationsobjekte ({"operation_type": "Update/Delete", [..] }) in einem Array zu einem Fehler.
  • Die maximale Größe des POST-Request-Bodys, die dieses endpoint akzeptieren kann, beträgt 5,000,000 Bytes.
  • Die Rate Limits für dieses endpoint liegen bei 1500 pro 1-Minuten-Fenster
  • Alle Parameter werden im Request-Body gesendet und ein Content-Type von application/json ist erforderlich.
  • Batch-Anfragen schlagen als Gruppe gemeinsam fehl oder sind gemeinsam erfolgreich, und alle API-Antworten für sowohl Fehler als auch Erfolg bewahren die Elementreihenfolge der ursprünglichen Anfrage.
Batch-Antworten Die von der Ads API zurückgegebene Antwort enthält zwei fields, success_count und total_count. Diese Werte müssen immer gleich sein und zählen, wie viele Datensätze in der Anfrage vom Backend verarbeitet wurden. Eine Situation, in der die Anzahl der im Request-Body gesendeten Datensätze nicht dem success_count und total_count entspricht, sollte als Fehlerzustand behandelt werden und einen erneuten Versuch erfordern. Batch-Fehler
  • Fehler auf Anfrageebene (z. B. maximale Batch-Größe überschritten) werden in der Antwort unter dem Objekt errors angezeigt.
  • Fehler auf Elementebene (z. B. fehlende erforderliche Parameter) werden in der Antwort unter dem Objekt operation_errors angezeigt.
  • Der Index des Fehlers in den operation_errors bezieht sich auf den Index des Eingabeelements, mit der entsprechenden Fehlermeldung
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id/users Parameters
NameDescription
account_id
required
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 Nutzer zugeordnet sein.

Type: string

Example: 18ce54d4x5t
do_not_reach_list_id
required
Ein Verweis auf die Do Not Reach List, mit der Sie in der Anfrage arbeiten

Type: string

Example: 2906h
operation_type
required
Der pro users-Gruppe ausgeführte Operationstyp.

Type: enum

Possible values: Update, Delete
params
required
Ein JSON-Objekt, das das emails-Array und den expires_at-Zeitstempel enthält.

Type: JSON
users
required
Ein Array von JSON-Objekten, das alle Parameter für einen einzelnen Nutzer enthält.

Type: JSON
expires_at
optional
Die UTC-Zeit, zu der die Nutzerzuordnung(en) ablaufen soll(en). Die angegebene Zeit muss später als der aktuelle Zeitstempel sein. Ausgedrückt in ISO 8601. Standardmäßig 13 Monate ab dem aktuellen Zeitstempel.

Type: string

Example: 2017-07-05T07:00:00Z
Angesichts des Multi-Key-Ansatzes für das users-Objekt wird jedes Element dieses Objekts unten dokumentiert:
NameBeschreibung
email
optional
E-Mail-Adresse(n) des Benutzers.

Type: Array[String]
phone_number
optional
Telefonnummer(n) des Benutzers.

Type: Array[String]
Beispielanforderung
`POST https://ads-api.x.com/12/batch/accounts/18ce54bgxky/do_not_reach_lists/4kzro/users`

    [
      {
        "operation_type": "Update",
        "params": {
          "expires_at": "2023-01-22T00:00:00Z",
          "users": [
            {
              "email": [
                "FEAD76F6ADF99FFFB997AA4E3C8AD38FF531BC4C956DBD03CD0163F744D8AABC"
              ],
              "phone_number": [
                "CCABF1B62A202E0FE28BC6C014983C89A65451DD4482BD66A0ADB65366F38A9A"
              ]
            },
            {
              "email": [
                "FEAD76F6ADF99FFFB997AA4E3C8AD38FF531BC4C956DBD03CD0163F744D8AABA"
              ],
              "phone_number": [
                "CCABF1B62A202E0FE28BC6C014983C89A65451DD4482BD66A0ADB65366F38A9E"
              ]
            }
          ]
        }
      }
    ]
Beispielantwort
    {
      "data": [
        {
          "success_count": 2,
          "total_count": 2
        }
      ],
      "request": [
        {
          "params": {
            "do_not_reach_list_id": "4ofrq",
            "expires_at": "2023-01-22T00:00:00Z",
            "account_id": "18ce54bgxky"
          },
          "operation_type": "Update"
        }
      ]
    }

DELETE accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id

Löscht die angegebene Do‑Not‑Reach‑List des aktuellen Kontos. Resource URL https://ads-api.x.com/12/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id Parameters Keine Example Request DELETE https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists/4ofrp Example Response
    {
      "request": {
        "params": {
          "do_not_reach_list_id": "4ofrp",
          "account_id": "18ce54bgxky"
        }
      },
      "data": {
        "targetable": false,
        "name": "Nicht-kontaktieren-Liste",
        "description": null,
        "id": "4ofrp",
        "reasons_not_targetable": [
          "PROCESSING",
          "TOO_SMALL"
        ],
        "created_at": "2022-02-08T23:02:07Z",
        "list_size": null,
        "updated_at": "2022-02-08T23:02:21Z",
        "deleted": true
      }
    }
I