Custom Audiences
Übersicht
- GET accounts/:account_id/custom_audiences
- GET accounts/:account_id/custom_audiences/:custom_audience_id




- 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.
- 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.
- 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.
- Match-Rate = aktive X Nutzer der letzten 90 Tage / Anzahl der bereitgestellten Nutzer
- 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.
p_user_id
)?
- Dies ist der Identifikator, den Ihr Unternehmen verwendet, um jeden Ihrer Kunden eindeutig zu identifizieren.
- Dies kann eine E-Mail-Adresse, Geräte-ID, X @Handle oder ID sein.
- 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.
- 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.
- Nein, es gibt keine Größenbeschränkung für die Full Data Match-Datei.
- Sobald die Datei von X empfangen wurde, dauert die Verarbeitung ungefähr 1 Tag.
CRM

Anforderungen für das Abgleichen 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 1 | p_user_1 |
gemeinsame Nutzerkennung 2 | p_user_1 |
gemeinsame Nutzerkennung 3 | p_user_1 |
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
- 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
- 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
- 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
Anweisungen zum Hashing
E-Mail-Normalisierung
@
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
Normalisierung der X User ID
@
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
ID-Sync-Integration
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
Parameter | Beschreibung |
p_id | Ihre von X zugewiesene Partner-id |
p_user_id | Die id des Nutzers im Partner-System |
ID-Sync-Pixel:
p_user_id
von abc würde der erzeugte Pixel wie folgt aussehen:
Spaltennummer | Spaltenname | Spaltentyp | Beschreibung |
1 | Partner-ID | string | Die „partner id“ ist die ID, die X dem Partner zur eindeutigen Identifizierung jedes Partners zuweist. |
2 | Nutzer-id im Partner-System | string | Die 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. |
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
- 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
- in Kleinbuchstaben, führende und nachgestellte Leerzeichen entfernen; z. B.:
support@x.com
- ohne @, in Kleinbuchstaben und führende sowie nachgestellte Leerzeichen entfernen; z. B.:
jack
- Standard-Integer; z. B.:
143567
SHA256
gehasht werden. Zusätzlich muss der endgültige Hash in Kleinbuchstaben vorliegen. Z. B. 49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d und nicht 49E0BE2AECCFB51A8DEE4C945C8A70A9AC500CF6F5CB08112575F74DB9B1470D
Custom Audiences: Web

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_user_id=xyz&p_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:
- Partner Targeting User File
- Targeting Conversion File
- 199.16.156.0/22
- 199.59.148.0/22
Spaltennummer | Spaltenname | Spaltentyp | Beschreibung |
---|---|---|---|
1 | partner id | string | Die „partner id“ ist die ID, die X dem Partner bereitstellt, um jeden Partner eindeutig zu identifizieren. |
2 | advertiser id | string | Die „advertiser id“ ist der @handle des Werbetreibenden. |
3 | p_user_id | string | Die „p_user_id“ ist die eindeutige ID, mit der der Nutzer vom Partner identifiziert wird. |
3 | confidence score | integer | Der „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. |
4 | segment label | string | Das „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. |
Integration der Audience API
Übersicht
- 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.
- Der Parameter
- 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
Schritt im Prozess | Audience API | (Veraltet) TON Upload |
---|---|---|
Shell-Audience erstellen | Kann über den [POST custom_audience endpoint]/x-ads-api/audiences erstellt werden | Kann über den [POST custom_audience endpoint]/x-ads-api/audiences erstellt werden |
Neuen Nutzer hinzufügen | Verwenden Sie operation_type Update mit dem Audience endpoint | Verwenden Sie operation ADD mit dem POST custom_audience_changes-endpoint |
Nutzer entfernen | Verwenden Sie operation_type Delete mit dem Audience endpoint | Verwenden Sie operation REMOVE mit dem POST custom_audience_changes-endpoint |
Nutzer Opt-out | Verwenden Sie operation_type Delete mit dem Audience endpoint und den entsprechenden custom_audience_id s, zu denen der Nutzer gehört | Verwenden Sie das Global opt-out endpoint |
- Gesamtanzahl der Operationen: 2500 Operationen
- Maximale Payload-Größe: 5.000.000 Bytes
Neue Custom Audience erstellen
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
id
und einer Beispielnutzlast wie folgt:
POST https://ads-api.x.com/11/accounts/18ce54d4x5t/custom_audiences/1nmth/users
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
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
Delete
zu entfernen, die sich aus beliebigen Audiences abgemeldet haben. Es gibt mehrere Möglichkeiten, dies umzusetzen:
- Nachverfolgen, welche Nutzer zu welchen Audiences gehören, und diese Nutzer einzeln aus jeder Audience entfernen.
- Den Nutzer aus allen Audiences entfernen, die einem Ads-Konto zugeordnet sind.
- 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
undtotal_count
zurück, entsprechend der Anzahl deruser
-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
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
Name | Description |
---|---|
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 |
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 URLhttps://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions
Parameters
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t |
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 |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions
Example Response
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 Antwortattributis_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
Name | Description |
---|---|
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 |
POST https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY
Example Response
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 Antwortattributis_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
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner für das genutzte Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten 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 |
DELETE https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions/ri
Example Response
Zielgruppen
GET accounts/:account_id/custom_audiences/:custom_audience_id/targeted
Ruft eine Liste aktiver oder aller Line Items und Kampagnen ab, die eine angegebenecustom_audience_id
anvisieren
Name | Beschreibung |
---|---|
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 einbezogenTyp: 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 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h/targeted
Beispielantwort
Nutzer in Custom Audiences
POST accounts/:account_id/custom_audiences/:custom_audience_id/users
Dieses Endpoint ermöglicht Partnern, Nutzer für eine angegebenecustom_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
vonapplication/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.
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.
https://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/users
Name | Description |
---|---|
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 |
users
wird jedes Element dieses Objekts unten dokumentiert:
Name | Description |
---|---|
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] |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/users
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 URLhttps://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id/permissions
Parameters
Name | Beschreibung |
---|---|
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 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/permissions
Example Response
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 Antwortattributis_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
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner für das verwendete Konto. Er erscheint im Ressourcenpfad und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten 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 |
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 Antwortattributis_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
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten 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 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/1nmth/permissions/ri
Beispielantwort
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-URLhttps://ads-api.x.com/12/accounts/:account_id/custom_audiences
Parameter
Name | Beschreibung |
---|---|
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 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences?custom_audience_ids=1nmth
Beispielantwort
GET accounts/:account_id/custom_audiences/:custom_audience_id
Rufen Sie spezifische Custom Audiences ab, die dem aktuellen Account zugeordnet sind. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id
Parameters
Name | Description |
---|---|
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 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h
Example Response
POST accounts/:account_id/custom_audiences
Erstellen Sie eine neue Platzhalter-Custom Audience, die dem aktuellen Account zugeordnet ist. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/custom_audiences
Parameters
Name | Description |
---|---|
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 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences?name=developers
Example Response
PUT accounts/:account_id/custom_audiences/:custom_audience_id
Aktualisiert die spezifische Custom Audience, die dem aktuellen Konto zugeordnet ist. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id
Parameters
Name | Description |
---|---|
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 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h?name=developers_changed
Example Response
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
vonapplication/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.
- 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 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.
https://ads-api.x.com/12/batch/accounts/:account_id/custom_audiences
Parameters
Name | Beschreibung |
---|---|
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 |
POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/custom_audiences
DELETE accounts/:account_id/custom_audiences/:custom_audience_id
Löscht die angegebene Custom Audience, die dem aktuellen Account zugeordnet ist. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/custom_audiences/:custom_audience_id
Parameters
Name | Description |
---|---|
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 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/custom_audiences/2906h
Example Response
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: Eineaccount_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
Name | Description |
---|---|
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 |
GET https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists
Example Response
POST accounts/:account_id/do_not_reach_lists
Erstellen Sie eine neue Do Not Reach List, die dem aktuellen Konto zugeordnet ist. Hinweis: Einaccount_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
Name | Beschreibung |
---|---|
account_id erforderlich | Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API‑Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t |
description optional | Eine Beschreibung für diese Zielgruppe. Typ: string Beispiel: A list of users to exclude |
POST https://ads-api.x.com/12/accounts/18ce54bgxky/do_not_reach_lists?description=A list of users to exclude
Example Response
POST batch/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id/users
Dieses endpoint ermöglicht es, Nutzer zu einer bestimmtendo_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
- 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
vonapplication/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.
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
https://ads-api.x.com/12/batch/accounts/:account_id/do_not_reach_lists/:do_not_reach_list_id/users
Parameters
Name | Description |
---|---|
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 |
users
-Objekt wird jedes Element dieses Objekts unten dokumentiert:
Name | Beschreibung |
---|---|
email optional | E-Mail-Adresse(n) des Benutzers. Type: Array[String] |
phone_number optional | Telefonnummer(n) des Benutzers. Type: Array[String] |
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 URLhttps://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