Kampagnenverwaltung

​

Advertiser-API

Planen Sie Kampagnen programmgesteuert und verwalten Sie Anzeigen auf X mit dieser API-Suite.

​

Was können Sie bewerben?

​

Promoted Ads

• Promoted Ads sind gewöhnliche Anzeigen, die von Werbetreibenden gekauft werden, um eine größere Gruppe von Nutzern zu erreichen oder das Engagement ihrer bestehenden Follower zu steigern.
• Promoted Ads sind deutlich als Promoted gekennzeichnet, wenn ein Werbetreibender für ihre Platzierung auf X bezahlt. In jeder anderen Hinsicht verhalten sich Promoted Ads wie normale Anzeigen und können repostet, beantwortet, geliked und mehr werden. Sie unterliegen typischen Auslieferungsregeln und werden mit POST statuses/update erstellt.
• „Promoted-only“-Tweets, erstellt über POST accounts/:account_id/tweet, können in Promoted-Tweets-Kampagnen verwendet werden, werden jedoch nicht an Follower ausgeliefert oder in der öffentlichen Timeline angezeigt. Um eine Liste der Promoted-only-Tweets für ein bestimmtes Konto abzurufen, verwenden Sie GET accounts/:account_id/scoped_timeline.

​

Promoted Accounts

• Promoted Accounts sind Teil von „Who to follow“ und schlagen Accounts vor, denen Nutzer derzeit nicht folgen und die sie interessant finden könnten. Promoted Accounts helfen dabei, eine noch größere Vielfalt an Accounts vorzustellen, die Nutzer ansprechen könnte.
• Promoted Accounts für die Timeline verknüpfen einen Promoted Tweet mit einer Promoted-Account-Kampagne und werden in den Timelines der Nutzer angezeigt.

Promoted Trends sind in der Ads API nicht verfügbar.

​

Kampagnen und Anzeigengruppen (Line Items)

Kampagnen legen den Zeitplan und das Budget einer Anzeige fest. Der Werbetreibende definiert ein Tagesbudget und ein Gesamtbudget. Die Kampagne kann an eine bestimmte Start- und Endzeit gebunden sein oder durchgehend laufen, bis das Budget aufgebraucht ist. Das Budget wird einem der Funding Instruments des Werbekontos entnommen. Kampagnenkennungen (:campaign_id) sind die Base‑36-Darstellung des Base‑10-Werts, den wir in der X Ads UI anzeigen.

Werbekonten sind auf maximal 200 aktive Kampagnen begrenzt. Dieses Limit kann auf Anfrage vom X Account Manager des Werbetreibenden manuell auf 4.000 aktive Kampagnen erhöht werden. Eine Kampagne gilt als aktiv, bis sie ihre Endzeit erreicht oder gelöscht wird. Pausierte Kampagnen gelten bis zu ihren festgelegten Endzeiten als aktiv.

Line Items verbrauchen das durch eine Kampagne festgelegte Budget. Line Items bündeln das Gebot pro Interaktion, den zu bewerbenden Tweet oder Account sowie die Targeting-Regeln.

​

Analytics

Die X Ads API stellt eine Reihe von Analytics-endpoints bereit, um die Anzeigenleistung zu verfolgen und zu optimieren. Weitere Informationen finden Sie unter Analytics und Analytics Best Practices.

Bei der Abrechnungsmetrik sind die data bis zu drei Tage nach dem Ereignis möglicherweise noch nicht final. Bis zu diesem Zeitpunkt sollten die data als vorläufig betrachtet werden. Die endgültige abrechenbare Zahl wird stets geringer sein als der vorläufige Betrag. Die abrechenbare Zahl wird um Spam und verwandten minderwertigen Traffic bereinigt. Siehe Timezones für weitere Überlegungen zur Zeit.

​

Eine Kampagne erstellen – Schritt für Schritt

Im folgenden Beispiel wird vorausgesetzt, dass Sie Ihre App und Ihren Benutzer mit twurl installiert, konfiguriert und autorisiert haben. twurl ist ein Befehlszeilentool nach dem Vorbild von cURL, das die X-OAuth-Authentifizierung zuverlässig handhabt. twurl eignet sich hervorragend, um die Funktionalität der Ads API (und der REST-API) schnell zu testen und zu debuggen. Um die vollständigen Header der Anfrage und Antwort anzuzeigen, verwenden Sie -t, um den Aufruf zu tracen; dies entspricht in etwa der Option -v von cURL.

In diesem Beispiel erstellen wir eine Promoted-Ads-Kampagne, die per Keyword-Targeting ausgerichtet wird.

1. Rufen Sie die account id ab.

twurl -H ads-api.x.com /9/accounts/

{
  "request": {
    "params": {
    }
  },
  "data": [
    {
      "name": "Testkonto für @AdsAPI",
      "timezone": "America/Los_Angeles",
      "timezone_switch_at": null,
      "id": "xxxxxx",
      "created_at": "2014-03-09T00:41:49Z",
      "salt": "f9f9d5a5f23075c618da5eb1d1a9df57",
      "updated_at": "2015-01-29T00:41:49Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ],
  "data_type": "account",
  "total_count": 1,
  "next_cursor": null
}

2. Rufen Sie die id des Finanzierungsinstruments ab.

Senden Sie die API-Anfrage GET accounts/:account_id/funding_instruments unter Verwendung der im vorherigen Befehl abgerufenen Konto-id.

twurl -H ads-api.x.com /9/accounts/xxxxxx/funding_instruments

{
  "data": [
    {
      "cancelled": true,
      "created_at": "2014-03-09T00:41:49Z",
      "credit_limit_local_micro": null,
      "currency": "USD",
      "deleted": false,
      "description": null,
      "end_time": null,
      "funded_amount_local_micro": null,
      "id": "yyyy",
      "type": null,
      "updated_at": "2014-05-29T00:41:49Z"
    }
  ],
  "data_type": "funding_instrument",
  "next_cursor": null,
  "request": {
    "params": {
      "account_id": "xxxxxx"
    }
  },
  "total_count": 1
}

3. Erstellen Sie eine Kampagne und verknüpfen Sie sie dem Finanzierungsinstrument.

Legen Sie eine Startzeit und ein Budget für die Kampagne fest. In diesem Beispiel verwenden wir ein Budget von 500 $und ein Tageslimit von 50$.

twurl -H ads-api.x.com -d "funding_instrument_id=yyyy&name=Meine erste Kampagne&total_budget_amount_local_micro=500000000&daily_budget_amount_local_micro=50000000" /9/accounts/xxxxxx/campaigns

{
  "data": {
    "created_at": "2015-02-09T00:00:00Z",
    "currency": "USD",
    "daily_budget_amount_local_micro": 50000000,
    "deleted": false,
    "end_time": null,
    "funding_instrument_id": "yyyy",
    "id": "92ph",
    "name": "Meine erste Kampagne",
    "entity_status": "PAUSED",
    "standard_delivery": true,
    "total_budget_amount_local_micro": 500000000,
    "updated_at": "2015-02-09T00:00:00Z"
  },
  "data_type": "campaign",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "daily_budget_amount_local_micro": 50000000,
      "funding_instrument_id": "yyyy",
      "name": "Meine erste Kampagne",
      "total_budget_amount_local_micro": 500000000
    }
  }
}

4. Erstellen Sie ein mit der Kampagne verknüpftes Line Item.

Da wir nun eine Kampagnen-id haben, können wir ein Line Item erstellen, das mit ihr verknüpft ist. Das Line Item umfasst den Gebotspreis, das Targeting und den eigentlichen Creative-Teil der Kampagne. Für dieses Line Item bewerben wir tweets mit einem Gebot von 1,50 $.

twurl -H ads-api.x.com -d "campaign_id=XXXX&bid_amount_local_micro=1500000&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&objective=ENGAGEMENTS&entity_status=PAUSED" /9/accounts/xxxxxxx/line_items

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "Ohne Titel",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "azjx",
    "entity_status": "PAUSED",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:00Z",
    "updated_at": "2015-02-09T00:00:00Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "92ph",
    "deleted": false
  },
  "request": {
    "params": {
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "bid_amount_local_micro": 1500000,
      "product_type": "PROMOTED_TWEETS",
      "entity_status": "PAUSED",
      "account_id": "xxxxxxx",
      "campaign_id": "92ph"
    }
  }
}

5. Erstellen Sie ein Targeting-Profil, das dem Line Item zugeordnet ist.

Nachdem das Line Item erstellt wurde, können wir Targeting-Kriterien zuweisen. Wir möchten im Großraum San Francisco (Bay Area) auf die Schlüsselwortphrase „grumpy cat“ abzielen. Dafür sind eine Standort-id-Abfrage und zwei POST-Anfragen an targeting_criteria erforderlich.

twurl -H ads-api.x.com "/9/targeting_criteria/locations?location_type=CITIES&q=San Francisco"

{
  "data": [
    {
      "name": "San Francisco-Oakland-San Jose CA, US",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  ],
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "location_type": "CITY",
      "q": "San Francisco"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=LOCATION&targeting_value=5122804691e5fecc" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:15Z",
    "deleted": false,
    "id": "2u3be",
    "line_item_id": "yyyy",
    "name": "San Francisco-Oakland-San Jose CA, US",
    "targeting_type": "LOCATION",
    "targeting_value": "5122804691e5fecc",
    "updated_at": "2013-05-30T21:01:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=PHRASE_KEYWORD&targeting_value=grumpy cat" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:20Z",
    "deleted": false,
    "id": "2u3bd",
    "line_item_id": "yyyy",
    "name": "grumpy cat",
    "targeting_type": "PHRASE_KEYWORD",
    "targeting_value": "grumpy cat",
    "updated_at": "2013-05-30T18:05:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "PHRASE_KEYWORD",
      "targeting_value": "grumpy cat"
    }
  }
}

6. Beenden Sie abschließend die Pause des Line Items.

twurl -H ads-api.x.com -X PUT "/9/accounts/xxxxxx/line_items/yyyy/?entity_status=ACTIVE"

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "grumpy cat",
    "placements": [],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "yyyy",
    "entity_status": "ACTIVE",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:20Z",
    "updated_at": "2015-02-09T00:00:20Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "dy1f",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "yyyy",
      "entity_status": "ACTIVE",
      "account_id": "xxxxxx"
    }
  }
}

Das war’s! Wir haben jetzt eine aktive, zielgerichtete und finanzierte Kampagne für Promoted Tweets in Timelines, die bereits läuft.

​

Zielbasierte Kampagnen

Zielbasierte Kampagnen und Preisgestaltung ermöglichen es Werbetreibenden, für die Aktionen zu bezahlen, die ihren Marketingzielen entsprechen. Zur Unterstützung dessen setzen Sie das passende objective auf Line Items.

Der Parameter, der bei den Write-endpoints für Line Items verwendet und bei den Read-endpoints zurückgegeben wird, lautet objective. Dieses Feld hat derzeit die folgenden möglichen Werte:

• APP_ENGAGEMENTS
• APP_INSTALLS
• FOLLOWERS
• ENGAGEMENTS
• REACH
• VIDEO_VIEWS
• PREROLL_VIEWS
• WEBSITE_CLICKS

Ziele beeinflussen, wie wir Kampagnen in unseren Auktionen optimieren und wie wir diese Kampagnen abrechnen. Wir ermöglichen eine auf dem Ziel basierende Preisgestaltung, z. B. CPAC für APP_ENGAGEMENTS, CPAC oder CPI für APP_INSTALLS, CPLC für WEBSITE_CLICKS, CPF für FOLLOWERS, CPE für ENGAGEMENTS und CPM für REACH.

Kampagnen zur Bewerbung mobiler Apps müssen entweder das Ziel APP_ENGAGEMENTS oder APP_INSTALLS enthalten.

Hinweis: Line Items mit unterschiedlichen Zielen sind innerhalb derselben Kampagne nicht zulässig.

Kampagnenziel	API-Objective	Medien in Tweets	Preismodell
App-Re-Engagements	APP_ENGAGEMENTS	Bild- oder Video-App-Download-Card erforderlich.	CPAC
App-Installationen	APP_INSTALLS	Bild- oder Video-App-Download-Card erforderlich.	CPAC oder CPI (festgelegt über charge_by)
Reichweite	REACH	Keine Einschränkungen.	CPM
Follower	FOLLOWERS	Tweet nicht erforderlich, aber empfohlen. Es gibt keine Medieneinschränkungen für Tweets bei Follower-Kampagnen, wir empfehlen jedoch reine Text-Tweets. Weitere Informationen	CPF
Engagements	ENGAGEMENTS	Keine Einschränkungen.	CPE
Videoaufrufe	VIDEO_VIEWS	Video-Conversation-Card, Video oder GIF erforderlich.	CPV oder Kosten pro 3s/100%-Ansicht
Pre-Roll-Aufrufe	PREROLL_VIEWS	Video erforderlich.	CPV oder Kosten pro 3s/100%-Ansicht
Website-Klicks	WEBSITE_CLICKS	Website-Card empfohlen, aber nicht erforderlich. Der Tweet muss entweder eine Website-Card oder einen Website-Link enthalten (nicht beides).	CPLC

​

Finanzierungsinstrumente

Finanzierungsinstrumente sind die Quelle des Kampagnenbudgets. Finanzierungsinstrumente können nicht über die Ads API erstellt werden; sie müssen bereits durch die/den Kundenbetreuer:in der Werbetreibenden bei X (für Kreditlinien) oder über ads.x.com (für Kreditkarten) eingerichtet sein, um zur Verfügung zu stehen.

Eine Liste aller funding_instruments in einem Account erhalten Sie unter GET accounts/:account_id/funding_instruments und die Details zu einem bestimmten Instrument unter GET accounts/:account_id/funding_instruments/:funding_instrument_id.

​

Attribute von Finanzierungsinstrumenten

Beschreibend: account_id, id des Finanzierungsinstruments, type des Finanzierungsinstruments, description und io_header (Insertion-Order-Header-ID). Beachten Sie, dass ein einzelner io_header mehreren Finanzierungsinstrumenten zugeordnet sein kann.

Finanzierungsfähigkeit: able_to_fund und reasons_not_able_to_fund.

Zeit: created_at, updated_at, start_time und end_time, dargestellt als Zeichenfolge im Format „%Y-%m-%dT%l:%M:%S%z“.

Boolescher Status: paused, deleted und cancelled (true oder false).

Finanziell: currency (Format nach ISO-4217), credit_limit_local_micro, credit_remaining_local_micro und funded_amount_local_micro. Währungsbeträge werden in „Micros“ angegeben. Bei USD entspricht $5,50 dem Wert 5.50*1e6 bzw. 5.500.000. Um einen „Vollbetrag“ darzustellen, müssen Sie den lokalen Micro-Betrag für alle Währungen mit 1e6 (1_000_000) multiplizieren.

​

Attributdetails

credit_limit_local_micro ist nur für Finanzierungsinstrumente des Typs CREDIT_CARD oder CREDIT_LINE gültig und steht für das Kreditlimit dieses Instruments.

funded_amount_local_micro ist nur für Finanzierungsinstrumente des Typs INSERTION_ORDER gültig und steht für das zugewiesene Budget.

credit_remaining_local_micro ist für Finanzierungsinstrumente der Typen CREDIT_LINE und AGENCY_CREDIT_LINE gültig. Es entspricht credit_limit_local_micro minus dem bereits für dieses Finanzierungsinstrument ausgegebenen Betrag. Es entspricht nicht der Differenz zwischen funded_amount_local_micro und dem ausgegebenen Betrag. Wir unterscheiden zwischen Kreditlimit und finanziertem Betrag, da sie unterschiedliche zugrunde liegende Finanzierungsmethoden und Ausgabenvereinbarungen mit Werbetreibenden widerspiegeln.

​

Arten von Finanzierungsinstrumenten

Kreditkarten

Typischerweise von Self-Service-Werbetreibenden verwendet (ohne Account Manager).

Kreditlinien

Diese liegen in Form von Insertion Orders (IOs) vor und werden von Account Managern festgelegt.

Multi-Handle-Kreditlinien

Mit dieser Art von Kreditlinie können Werbetreibende Kampagnen über mehrere Handles hinweg finanzieren. Diese Funktion wird von ihrem X Account Manager aktiviert, der die verschiedenen @Handles einer bestimmten Kreditlinie zuordnet.

Beispielsweise können sowohl @NikeSB als auch @NikeFuel auf die @Nike-Kreditlinie zugreifen. Dieses Finanzierungsinstrument ist wie jedes andere verfügbar. Sie rufen die data ab, indem Sie eine GET-Anfrage an den funding_instrument endpoint senden. Hier ist eine Beispielantwort (beachten Sie den CREDIT_LINE type).

      GET https://ads-api.x.com/5/accounts/a0b1c3/funding_instruments

{
    "request": {
        "params": {
            "account_id": "a0b1c3"
        }
    },
    "data": [
        {
            "start_time": "2013-05-30T04:00:00Z",
            "description": "FakeNike - Kreditlinie",
            "credit_limit_local_micro": 150000000000,
            "end_time": null,
            "cancelled": false,
            "id": "i1234",
            "paused": false,
            "account_id": "a0b1c3",
            "reasons_not_able_to_fund": [],
            "io_header": null,
            "currency": "USD",
            "funded_amount_local_micro": 0,
            "created_at": "2013-05-30T18:16:38Z",
            "type": "CREDIT_LINE",
            "able_to_fund": true,
            "updated_at": "2013-05-30T18:16:38Z",
            "credit_remaining_local_micro": 123661919751,
            "deleted": false,
        }
    ],
    "data_type": "funding_instrument",
    "total_count": 1,
    "next_cursor": null
}

Das Einzige, was an diesem Finanzierungsinstrument besonders ist, ist der type und die Tatsache, dass es allen Konten zur Verfügung steht, die damit verknüpft sind. Natürlich wird das verbleibende Guthaben durch alle Kampagnen beeinflusst, die über dieses Instrument finanziert werden – über alle gemeinsam nutzenden Konten hinweg. Details dazu, welche Konten mit einer bestimmten Kreditlinie verknüpft sind, sind weder über die API noch über ads.x.com verfügbar.

Weitere Informationen zu den Enumerationen von Funding Instruments finden Sie hier.

​

Targeting

Targeting ist ein zentrales Konzept der Ads API. Targeting wird auf Ebene des Line Items festgelegt, und die Optionen variieren je nach Platzierung. Um neue Targeting-Kriterien festzulegen, verwenden Sie POST accounts/:account_id/targeting_criteria und PUT accounts/:account_id/targeting_criteria, um diese zu aktualisieren.

Verwenden Sie GET accounts/:account_id/line_items für eine Liste aller Line Items und GET accounts/:account_id/line_items/:line_item_id, um ein bestimmtes Line Item abzurufen.

​

Targeting-Optionen nach Platzierung

Die Produkte Promoted Tweets und Promoted Accounts können in verschiedenen Platzierungen verfügbar sein. Promoted Trends (PTr) sind nicht über die API verfügbar.

Für mögliche Platzierungskombinationen siehe den endpoint GET line_items/placements. Jede Platzierung bietet unterschiedliche Targeting-Optionen. Standort, Plattform und Geschlecht sind für alle verfügbar. Die anderen Optionen hängen vom type der Platzierung ab.

• X Search: Alters-Targeting, Geräte, Ereignisse, Geschlecht, Keyword-Typen (alle), Sprache, Standorte, Netzwerkaktivierung, Netzbetreiber, Plattform, Plattformversion, Tailored Audiences, nur WLAN
• X Timeline: Alters-Targeting, Geräte, Ereignisse, Follower von, Ähnlich wie Follower von, Geschlecht, Interessen, Sprache, Standorte, Netzwerkaktivierung, Netzbetreiber, Nicht exakte Keyword-Typen, Partner-Zielgruppentypen, Plattform, Plattformversion, Retargeting-Typen, Tailored Audiences, TV-Targeting-Typen, nur WLAN
• X Profiles & Tweet Details: Alters-Targeting, Geräte, Ereignisse, Follower von, Ähnlich wie Follower von, Geschlecht, Interessen, Sprache, Standorte, Netzwerkaktivierung, Netzbetreiber, Nicht exakte Keyword-Typen, Partner-Zielgruppentypen, Plattform, Plattformversion, Retargeting-Typen, Tailored Audiences, TV-Targeting-Typen, nur WLAN

​

Verständnis von Targeting-Typen

Alters-Targeting: Nutzer basierend auf bestimmten Alterssegmenten ansprechen. Eine Liste der Alterssegment-Enums finden Sie auf der Seite Enumerations.

Events: Geben Sie ein Event für das Targeting an. Pro Line Item kann nur ein Event verwendet werden. Verwenden Sie den endpoint GET targeting_criteria/events, um verfügbare Events für das Targeting zu finden.

Gender: Männlich (1) oder weiblich (2) ansprechen. Auf null lassen, um alle anzusprechen.

Installed App Store Categories: Verwenden Sie diesen Targeting-Typ, um Nutzer basierend auf den Kategorien der Apps anzusprechen, die sie installiert haben oder für die sie Interesse gezeigt haben. Siehe GET targeting_criteria/app_store_categories.

Interests: Nutzer nach Interessen ansprechen. Rufen Sie die Interessenliste über GET targeting_criteria/interests ab. Sie können bis zu 100 Interessen targeten.

Followers Of: Die Follower beliebiger vollständig promotabler Nutzer für das aktuelle Konto ansprechen (Hinweis: Der primäre Kontoinhaber ist derzeit der einzige vollständig promotable Nutzer dieses Kontos). Verwenden Sie GET accounts/:account_id/promotable_users, um eine Liste promotabler Nutzer zu erhalten.

Similar to Followers Of: Personen ansprechen, die dieselben Interessen haben wie Follower bestimmter Nutzer. Sie können bis zu 100 Users verwenden.

Locations: Geben Sie bis zu 2.000 Standorte für das Targeting an. Liste abrufen über GET targeting_criteria/locations. Es gibt zusätzliche Anforderungen für Anzeigen, die bestimmte Länder targeten. Weitere Informationen finden Sie unter Country Targeting and Display Requirements.

Keywords: Keyword-Targeting-Optionen sind je nach Platzierungsart unterschiedlich. Sie können bis zu 1000 Keywords für das Targeting verwenden (pro Line Item). Siehe den Abschnitt zu Keyword-Typen für Optionen.

Language Targeting: Nutzer ansprechen, die bestimmte Sprachen verstehen.

Mobile Network Operator Targeting: Ermöglicht Werbetreibenden, Nutzer basierend auf dem Mobilfunkanbieter anzusprechen, unter Verwendung des Targeting-Typs NETWORK_OPERATOR aus GET targeting_criteria/network_operators.

New Mobile Device Targeting: Nutzer basierend auf dem Datum erreichen, an dem sie X erstmals über ihr Gerät genutzt haben, unter Verwendung des Targeting-Typs NETWORK_ACTIVATION_DURATION mit operator_type LT für kleiner als und GTE für größer oder gleich.

Platforms, Platform Versions, Devices und Nur-WLAN: Ermöglicht das Targeting mobiler Geräte entlang verschiedener Kriterien. Platforms ist ein übergeordneter Targeting-Typ, der breite Gerätekategorien abdeckt. Beispielwerte sind iOS und Android. Devices ermöglichen es, Nutzer bestimmter mobiler Geräte anzusprechen, zum Beispiel iPhone 5s, Nexus 4 oder Samsung Galaxy Note. Platform versions ermöglichen es, Nutzer nach Versionen mobiler Betriebssysteme bis hin zur Punktversion zu targeten. Beispiele umfassen iOS 7.1 und Android 4.4. Nur-WLAN ermöglicht es, ausschließlich Nutzer anzusprechen, die ihre Geräte in einem WiFi-Netzwerk verwenden; wenn dies nicht gesetzt ist, werden Nutzer erreicht, die sowohl die Carrier-Verbindung als auch WiFi verwenden.

• Nutzer können Platforms und Devices targeten, wenn es keine Überschneidung gibt. Ich kann BlackBerry als Platform und iPad Air als Device gleichzeitig targeten.
• Nutzer können Devices und OS-Versionen gleichzeitig targeten. Ich kann iPad Air und iOS >= 7.0 targeten.
• Nutzer können keine Platforms targeten, die breiter sind als Devices. Ich kann iOS und iPad Air nicht targeten.

[Tailored Audiences]/x-ads-api/audiences: Erreichen Sie Nutzer über einen zugelassenen Anzeigenpartner, um Kundensegmente gezielt anzusprechen und mit ihnen auf X in Kontakt zu treten.

TV Targeting

TV-Show-Targeting: Erreichen Sie Personen, die mit bestimmten TV-Programmen interagieren. Dieses Targeting-Kriterium kann so konfiguriert werden, dass während einer aktiven Kampagne mit dem Targeting-Typ TV_SHOW fortlaufend ausgesteuert wird. Verwenden Sie die Endpoints GET targeting_criteria/tv_markets und GET targeting_criteria/tv_shows, um verfügbare TV-Sendungen zu ermitteln.

Tweet-Engager-Retargeting

Tweet-Engager-Retargeting ermöglicht es Werbetreibenden, geräteübergreifend Zielgruppen anzusprechen, die zuvor ihren beworbenen oder organischen Tweets auf X ausgesetzt waren oder mit ihnen interagiert haben. Mit diesem Targeting können Werbetreibende Personen erneut ansprechen, die Inhalte auf X gesehen oder mit ihnen interagiert haben und voraussichtlich weiter interagieren oder auf nachfolgende Botschaften bzw. Angebote konvertieren. Nutzer werden innerhalb von Minuten nach Exposition oder Interaktion targetbar und bleiben es bis zu 90 Tage für Interaktionen und 30 Tage für Expositionen.

Arten des Tweet-Engager-Targetings:

• ENGAGEMENT_TYPE, das entweder IMPRESSION oder ENGAGEMENT als Targeting-Wert akzeptiert. Dies gibt an, ob exponierte Nutzer (IMPRESSION) oder engagierte Nutzer (ENGAGEMENT) angesprochen werden sollen.
• CAMPAIGN_ENGAGEMENT verwendet eine Kampagnen-id als Targeting-Wert. Nutzer, die mit dieser Kampagne interagiert haben oder ihr ausgesetzt waren (abhängig von ENGAGEMENT_TYPE), werden angesprochen.
• USER_ENGAGEMENT verwendet die beworbene Nutzer-id als Targeting-Wert, um Nutzer anzusprechen, die einem organischen Inhalt eines Werbetreibenden ausgesetzt waren oder mit ihm interagiert haben (abhängig von ENGAGEMENT_TYPE). Dabei muss es sich um die mit dem Ads-Konto verknüpfte beworbene Nutzer-id handeln.

Hinweis: ENGAGEMENT_TYPE ist zusätzlich zu mindestens einem gültigen CAMPAIGN_ENGAGEMENT- oder USER_ENGAGEMENT-Wert erforderlich. Beide Tweet-Engager-Targeting-Typen können vorhanden sein, und es können mehrere Kampagnen in einem gegebenen Line Item angesprochen werden.

Video-Viewer-Targeting: Video-Viewer-Targeting baut auf Tweet-Engager-Targeting auf und ermöglicht es Werbetreibenden, Zielgruppen anzusprechen, die zuvor einen Teil oder das gesamte Video auf X angesehen haben. Werbetreibende können organische Videos, beworbene Videos oder beides targeten. Beworbene Videos sind nicht auf Kampagnen oder Line Items mit dem Ziel Videoaufrufe beschränkt.

Arten des Video-Viewer-Targetings:

• VIDEO_VIEW für Nutzer, die auf Wiedergabe geklickt oder 3 Sekunden Autoplay angesehen haben
• VIDEO_VIEW_PARTIAL für Nutzer, die 50% des Videos angesehen haben
• VIDEO_VIEW_COMPLETE für Nutzer, die mindestens 95% des Videos angesehen haben

Wie beim Tweet-Engager-Targeting muss bei Verwendung von ENGAGEMENT_TYPE eines oder beide der folgenden Kriterien in den Targeting-Kriterien für das Line Item ebenfalls vorhanden sein:

• CAMPAIGN_ENGAGEMENT verwendet eine Kampagnen-id als Targeting-Wert. Nutzer, die in dieser Kampagne ein Video angesehen haben (basierend auf ENGAGEMENT_TYPE), werden angesprochen.
• USER_ENGAGEMENT verwendet die beworbene Nutzer-id als Targeting-Wert, um Nutzer anzusprechen, die ein Video in einem organischen Inhalt eines Werbetreibenden angesehen haben (basierend auf ENGAGEMENT_TYPE). Dabei muss es sich um die mit dem Ads-Konto verknüpfte beworbene Nutzer-id handeln.

Keyword-Typen

Weitere Informationen finden Sie in unserem Support-Dokument zum Keyword-Targeting.

• Broad (Standardwert): stimmt mit allen Wörtern überein, unabhängig von der Reihenfolge. Unempfindlich gegenüber Groß-/Kleinschreibung, Plural oder Tempus. Wird nach Möglichkeit automatisch erweitert (z. B. würde „car repair“ auch „automobile fix“ entsprechen). Wenn Sie ohne Erweiterung targeten möchten, fügen Sie ein + vor den Keywords ein, z. B. „+boat +jet“. Die Verwendung von Keywords ohne + entspricht standardmäßig Broad Match.
• Unordered (veraltet): stimmt mit allen Wörtern überein, unabhängig von der Reihenfolge. Unempfindlich gegenüber Groß-/Kleinschreibung, Plural oder Tempus.
• Phrase: stimmt mit der exakten Keyword-Zeichenfolge überein; andere Keywords dürfen vorhanden sein.
• Exact: stimmt genau mit der Keyword-Zeichenfolge überein, mit keinen anderen.
• Negative: vermeidet Übereinstimmungen mit Suchanfragen, die irgendwo in der Abfrage alle diese Keywords enthalten, unabhängig von der Reihenfolge, selbst wenn andere Wörter vorhanden sind.
• Negative Phrase: vermeidet Übereinstimmungen mit Suchanfragen, die irgendwo in der Abfrage genau diese Keyword-Zeichenfolge enthalten, selbst wenn andere Wörter vorhanden sind.
• Negative Exact: vermeidet Übereinstimmungen mit Suchanfragen, die genau diesen Keywords entsprechen und keine anderen Wörter enthalten.  

Emoji-Targeting

Emoji-Targeting wird über Keyword-Targeting unterstützt. Um Emoji-Targeting zu verwenden, erstellen Sie einfach Keyword-Targeting für die Unicode-Codepoints, die das betreffende Emoji darstellen, z. B. U+1F602 (xF0x9Fx98x82 in UTF-8) für das Emoji „Gesicht mit Freudentränen“ (😂). Welche Emojis unterstützt werden, können Sie in der twemoji-Liste nachsehen. Das Targeting eines Emojis umfasst alle Varianten.

Eine Übersicht aller Werte mit Angaben zu Pflicht-/optionalen Feldern und spezifischen Details für jeden Eintrag finden Sie unter PUT accounts/:account_id/targeting_criteria.

​

Kombinationen von Targeting-Kriterien

Aktualisierter Kampagnen-Workflow

Erstellen Sie Kampagnen mit breit angelegtem Targeting anhand von Geo-, Geschlechts-, Sprach- sowie Geräte-/Plattform-Kriterien. Werbetreibende können dieses breite Targeting anschließend mit zusätzlichen Targeting-Kriterien kombinieren (z. B. Interessen, Keywords, Follower, Tailored Audiences, TV). Wenn für ein Line Item keine Targeting-Kriterien angegeben sind, richtet sich das Line Item an alle Nutzer weltweit.

„Primäre“ Typen	Andere Typen
Follower	Standorte
Tailored Audiences	Geschlecht
Interessen	Sprachen
Keywords	Geräte und Plattformen
TV	Alter

Die Targeting-Kriterien werden für Ihre Anzeigengruppe wie folgt kombiniert:

• „Primäre“ Targeting-Typen werden per ∪ kombiniert (d. h. in einer logischen Vereinigung).
• Andere Targeting-Typen werden per UND verknüpft.
• Gleiche Typen werden per ODER verknüpft.

Einige Beispiele

Auf einen Blick: [(Follower) ∪ (Tailored Audiences) ∪ (Interessen) ∪ (Keywords)] UND (Standort) UND (Geschlecht) UND (Sprachen) UND (Geräte und Plattformen)

Ein Geo-Beispiel:

Angenommen, wir möchten, dass eine Anzeigengruppe für unsere Kampagne wie folgt ausliefert:

• X Nutzer in den USA, in England und in Kanada (Standort)
• die Frauen sind (Geschlecht)
• abgeleitet aus einer Tailored-Audiences-Liste („Primär“)
• mit Keywords („Primär“)

Die Targeting-Kriterien lauten:

[US ODER GB ODER CA] UND [Weiblich] UND [Tailored Audiences ∪ Keywords]

​

Zusätzliche Beispiele

• Geschlecht und Geo auswählen, aber keine Primärauswahl: (Male) AND (US OR GB)
• Geschlecht, Geo und Interesse auswählen: (Female) AND (CA) AND (Computers OR Technology OR Startups)
• Geschlecht, Geo, Interesse, Tailored Audiences und Keywords auswählen: (Male) AND (GB) AND (Cars ∪ Tailored Audiences for CRM ∪ autocross)

​

Budgetsteuerung

Werbetreibende haben nun mehr Kontrolle darüber, wie schnell ihre Tagesbudgets für Ihre Kampagnen mit Promoted Tweet und Kontoanzeigen ausgegeben werden. Die Standardzustellung, die als Voreinstellung aktiviert ist, sorgt für eine gleichmäßige Ausgabenrate über den Tag.

Wenn Sie die Standardzustellung deaktivieren, liefern wir Impressionen aus und generieren Interaktionen so schnell wie möglich, bis Ihr Tagesbudget ausgeschöpft ist – je nach Targeting und Wettbewerb möglicherweise bereits früh am Tag. Dies wird als beschleunigte Zustellung bezeichnet.

Erste Schritte

Die Standardzustellung ist die Standardoption für alle Kampagnen; es ist keine Aktion erforderlich, es sei denn, Sie möchten sie deaktivieren. Um Ihr Tagesbudget in einer Kampagne so schnell wie möglich zu verbrauchen, setzen Sie den Parameter standard_delivery auf false, um auf beschleunigte Zustellung umzustellen (siehe GET accounts/:account_id/campaigns).

Hinweise

• „Tag“ bezieht sich auf die Zeitzone des X-Werbekontos (z. B. America/Los_Angeles).
• Erste Ergebnisse deuten darauf hin, dass die Standardzustellung eCPE/CPF für Werbetreibende verbessert und für eine konsistentere Abdeckung über den Tag sorgt.

Weitere Informationen zu Budgets und Taktung finden Sie in den FAQ zu Geboten und Auktionen.

​

Zielgebote

Kampagnenverwaltung

​

Gebotsstrategie

Wir haben das Konzept der Gebotsstrategie eingeführt, um den Workflow zur Kampagnenerstellung zu vereinfachen und Verwirrung über Kombinationen mehrerer Parameter zu reduzieren.

Alle bisherigen (als veraltet markierten) Parameterkombinationen können durch Setzen eines entsprechenden Zielparameters abgebildet werden. Weitere Informationen finden Sie in der Ankündigung hier.

Beispiel:

Kampagnenziel	Legacy	Ads API v10+
App-Installationen	bid_type = AUTO bid_unit = APP_INSTALLS charge_by = APP_CLICKS	goal = APP_INSTALLS bid_strategy = AUTO
Website-Klicks	bid_type = TARGET (Hinweis: bid_unit war für einige Kampagnenziele nicht erforderlich)	bid_strategy = TARGET

​

Zielgebotsstrategie

Mit der Zielgebotsstrategie können Sie einen Ziel‑CPC/-CPA festlegen, den Sie zahlen möchten. Die X Ads‑Plattform optimiert Ihre Kampagne auf Performance und hält die Kosten nahe an Ihrem Ziel oder darunter.

Diese Funktion bietet Ihnen die Flexibilität, Nutzer anzusprechen, die besonders wahrscheinlich die gewünschte Aktion ausführen (z. B. einen Link‑Klick, einen Lead oder ein Follow), und zugleich die Kosten unter Kontrolle zu halten. Sie ist besonders leistungsfähig für Werbetreibende, die mehr Optionen für die Kampagneneinrichtung und ‑optimierung (einschließlich Gebotsoptionen) wünschen.

Für Line Items mit kompatiblen Kampagnenzielen haben wir einen neuen Preismechanismus für den Gebotsbetrag eingeführt, mit dem Sie einen Zielkostenwert festlegen können. Unsere Anzeigenplattform gibt dynamisch in Ihrem Namen Gebote ab, um mehr Ergebnisse zu erzielen, und arbeitet gleichzeitig daran, Ihren durchschnittlichen Kostenwert innerhalb von 20 % Ihres angegebenen Ziels zu halten. Die Einstellung bid_strategy auf Line Items kann mit dem Wert TARGET konfiguriert werden, um die Zielgebotsstrategie für relevante Kampagnenziele zu aktivieren, etwa:

• WEBSITE_CLICKS
• WEBSITE_CONVERSIONS
• APP_INSTALLS
• APP_ENGAGEMENTS
• REACH

​

Länderspezifisches Targeting und Anzeigeanforderungen

Kampagnenverwaltung

Die länderspezifischen Targeting- und Anzeigeanforderungen sind auf dieser Seite aufgeführt. Diese Anforderungen sind von allen Partnern einzuhalten.

​

Russland

Die Anzeigenrichtlinien von X untersagen Werbetreibenden, Russland mit Anzeigen zu adressieren, die nicht in russischer Sprache verfasst sind. Wenn Ihre Nutzer Russland gezielt ansprechen, müssen Sie ihnen die folgende Warnmeldung anzeigen:

Anzeigen, die auf Russland abzielen, müssen in russischer Sprache verfasst sein.

​

Vom Partner verwaltete Finanzierungsmittel

Der Onboarding-Prozess richtet ein ads.x.com-Konto für das zugehörige X Konto ein, das vom Partner über die Ads API verwaltet werden kann und dessen Werbeausgaben dem Partner in Rechnung gestellt werden.  

​

Erste Einrichtung für Partner

Der Prozess zur erstmaligen Einrichtung eines neuen PMFI-Ads-API-Partners dauert bis zu drei Wochen ab Austausch der erforderlichen Informationen. Um den Prozess zu starten, müssen die folgenden Informationen sowohl mit Ihren technischen Ansprechpartnern bei X als auch mit dem X‑Kontakt, der die Integration mit dem Partner betreut, geteilt werden:

• Der Partner muss seinen PGP/GPG-Public Key bereitstellen. Ein gemeinsamer geheimer Schlüssel muss zwischen dem Ads-API-Partner und X ausgetauscht werden. Dieser wird während des Onboarding-Prozesses zur Verifizierung von data verwendet.
• Die app_id oder consumer_secret für die X App, die für den Zugriff auf die Ads API verwendet wird. Sie können Ihre bestehenden X Apps über das App-Dashboard einsehen und verwalten, wenn Sie in Ihrem X Konto auf developer.x.com angemeldet sind. Wenn Sie eine X App erstellen müssen, benötigen Sie ein genehmigtes Developer-Konto. X erlaubt eine App für Produktion+Sandbox und optional eine weitere App ausschließlich für Sandbox-Zugriff. Die X App muss über einen unternehmensbezogenen, vom Partner kontrollierten X Handle erstellt werden.  

​

Onboarding-Ablauf für Advertiser

Der Onboarding-Ablauf für Advertiser erfolgt über einen Webbrowser wie folgt:

1. Der Nutzer startet den Onboarding-Ablauf auf der Website des Partners und gibt den Handle ein, den er onboarden möchte.
2. Der Partner leitet den Nutzer mit einer signierten Payload zu einer URL auf ads.x.com weiter. Diese Payload enthält die API-app_id des Partners, die X-user_id des X-Handles, das onboardet werden soll, sowie eine Callback-URL und weitere unten dokumentierte fields.
3. Der Nutzer wird aufgefordert, sich über die Standard-Anmeldeseite von x.com bei ads.x.com anzumelden.
4. Sobald der Nutzer angemeldet ist, wird der Onboarding-Prozess gestartet. Dieser Schritt umfasst die Anzeigenprüfung, die Kontoverifizierung und weitere Prüfungen.
5. Wenn alle Onboarding-Aufgaben abgeschlossen sind, wird der Nutzer zur vom Ads API‑Partner bereitgestellten Callback-URL weitergeleitet, mit einer Payload, die Erfolg oder Misserfolg anzeigt. Dies umfasst den 3-legged-Authorisierungsprozess.  

​

Onboarding-Redirect-Payload

URL für Redirect:

https://ads.x.com/link_managed_account

Die Redirect-URL wird mit den folgenden Parametern aufgerufen:

Name	Type	Beschreibung
callback_url	URL-codierte Zeichenfolge	Der Nutzer wird nach Abschluss des Konto-Verknüpfungsprozesses unabhängig vom Ergebnis zu dieser URL weitergeleitet. Siehe den Abschnitt zur Partner-Redirect-URL für Protokolldetails.
client_app_id	integer	X API Client App id, wird verwendet, um den verwaltenden Partner zu identifizieren
promotable_user_id	integer	X user_id des @Handle, dessen Promotions vom verwaltenden Partner verwaltet werden sollen. Dient zur Sicherstellung, dass es derselbe Nutzer ist, der sich bei ads.x.com anmeldet, um den Verknüpfungsprozess abzuschließen
fi_description	URL-codierte Zeichenfolge (max. 255 Zeichen)	Name des Funding Instruments. Dieser wird im Beschreibungsfeld in der API angezeigt, wenn das Funding Instrument abgerufen wird. Wenn eine funding_instrument-Beschreibung angegeben wird, wird das vorhandene funding_instrument pausiert und ein neues Managed-Partner-Funding-Instrument eingerichtet. (Falls bereits eines mit demselben Namen existiert, passiert nichts.)
timezone	String im Format Area/Location	Diese Zeitzone wird verwendet, um den Tag zu bestimmen, auf den Tagesbudgets angewendet werden, und in dem Belastungen aggregiert werden
currency	ISO-4217-Währungscode	Währung, die für Gebote verwendet wird und in der Belastungen abgerechnet werden
country	ISO-3166-1-Alpha-2-Ländercode	Abrechnungsland für das Konto
signature	URL-codierter, base64-codierter Binärcode, wie unten erläutert	Signatur, die ein gemeinsames Geheimnis und die anderen Parameter kombiniert, um die Authentizität des Aufrufs sowie die Gültigkeit der Parameter zu verifizieren.

​

Callback-URL-Nutzlast

Die Basis-Redirect-URL wird über den Parameter callback_url in der Account-Link-Anfrage bereitgestellt (siehe oben). Die von ads.x.com hinzugefügten Parameter sind:

Name	Type	Beschreibung
status	string	OK Ein Konto wurde erstellt oder ein vorhandenes, berechtigtes Konto wurde gefunden. ACCOUNT_INELIGIBLE wenn partnerspezifische Voraussetzungen nicht erfüllt sind USER_MISMATCH das für die Anmeldung bei ads.x.com verwendete X-Konto unterschied sich von der promotable_user_id in der Account-Link-Anfrage INCOMPLETE_SERVING_BILLING_INFO Zeitzone, Währung oder Land wurden nicht angegeben INVALID_COUNTRY es wurde ein ungültiger Länderkonfigurationswert übermittelt INVALID_CURRENCY es wurde ein ungültiger Währungskonfigurationswert übermittelt INVALID_TIMEZONE es wurde ein ungültiger Zeitzonenwert übermittelt
account_id	URL-codierter string	X Ads-Konto-id des verknüpften Kontos
funding_instrument_id	URL-codierter string	ID des aktiven, vom Partner verwalteten Zahlungsinstruments
signature	URL-codierter, base64-codierter Binärcode, wie unten erläutert	Base64-codierte HMAC-SHA1-Signatur, die ein gemeinsames Geheimnis und die anderen Parameter kombiniert, um die Authentizität des Aufrufs sowie die Gültigkeit der Parameter zu prüfen. Um sicherzustellen, dass die Callback-URL nur für die X user_id gilt, für die der Account-Link-Prozess vorgesehen war, ist die X user_id beim Signieren der Anfrage an das gemeinsame Geheimnis anzuhängen (mit &).

Um sicherzustellen, dass die Callback-URL nur für die X user_id gilt, für die der Account-Link-Prozess vorgesehen war, ist die X user_id beim Signieren der Anfrage an das gemeinsame Geheimnis anzuhängen (mit &).  

​

Signieren der Request- und Callback-URLs

Um sicherzustellen, dass die Requests an /link_managed_account und die Callback-URL gültig sind, müssen die Requests an der Quelle signiert und vom Empfänger verifiziert werden, bevor der Empfänger darauf reagiert. Das Signieren des Requests mit einem zwischen X und dem verwaltenden Partner geteilten Secret stellt sicher, dass jede Partei nur Requests akzeptiert, die vom autorisierten Gegenüber gesendet wurden.

Der Algorithmus zur Signaturerzeugung ähnelt dem in OAuth verwendeten.

Erstellen Sie eine Signatur-Basiszeichenfolge wie folgt:

• Konvertieren Sie die HTTP-Methode in Großbuchstaben und setzen Sie die Basiszeichenfolge auf diesen Wert.
• Hängen Sie das Zeichen „&“ an die Basiszeichenfolge an.
• Prozentkodieren Sie die URL (ohne Parameter) und hängen Sie sie an die Basiszeichenfolge an.
• Hängen Sie das Zeichen „&“ an die Basiszeichenfolge an.
• Hängen Sie die prozentkodierte Query-String an, die wie folgt aufgebaut ist:
• Prozentkodieren Sie jeden Key und jeden Value, die signiert werden sollen.
• Sortieren Sie die Liste der Parameter alphabetisch nach dem Key.
• Für jedes Key/Value-Paar (und mit primary_promotable_user_id für die Partner-Redirect-URL):
• Hängen Sie den prozentkodierten Key an die Query-String an.
• Hängen Sie das Zeichen „=“ an die Basiszeichenfolge an.
• Hängen Sie den prozentkodierten Value an die Query-String an.
• Trennen Sie die prozentkodierten key=value-Paare mit dem Zeichen „&“.
• Verwenden Sie den HMAC-SHA1-Algorithmus, wobei das zuvor ausgetauschte gemeinsame Secret als Key und die Basiszeichenfolge als Value dient, um die Signatur zu erzeugen.
• Base64-kodieren Sie die Ausgabe aus Schritt 2, entfernen Sie das abschließende Newline-Zeichen, prozentkodieren Sie die in Schritt 3 erzeugte Signatur und fügen Sie sie der URL in einem signature-Parameter hinzu  

​

Signaturbeispiele

Signieren einer Link-Account-Anfrage

Zu signierende URL, unter der Annahme einer GET-Anfrage:

https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1

Diese URL hat die folgenden Parameter:

callback_url = https://managingpartner.com/link_account_callback client_app_id = 12345 fi_description = some name promotable_user_id = 1

Die Basiszeichenkette, bestehend aus HTTP-Methode und URL ohne Parameter (Schritte a–d), sieht wie folgt aus:

GET https://ads.x.com/link_managed_account

Die Abfragezeichenfolge, erzeugt durch die Teilschritte von e, sieht wie folgt aus:

callback_url=https://managingpartner.com/link_account_callback&client_app_id=12345&fi_description=some name&promotable_user_id=1

Beachten Sie, dass die Schlüssel-Wert-Paare nach Schlüsselnamen sortiert sind.

Die prozentcodierte Abfragezeichenfolge sieht wie folgt aus:

callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1

Die vollständige Basiszeichenkette, die die Schritte a–d und e kombiniert:

GET https://ads.x.com/link_managed_account&callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1

Mit dem Algorithmus hmac-sha1 signieren wir dies mit dem Wort „secret“ als Schlüssel. Das Ergebnis wird Base64-codiert und ohne das abschließende „\n“ dargestellt (Schritte 2 und 3): KBxQMMSpKRrtg9aw3qxK4fTXvUc=

Diese Signatur wird dann (prozentcodiert) am Ende der ursprünglichen URL im Parameter signature hinzugefügt (Schritt 4):

https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D

Signieren einer Partner-Redirect-URL (Callback für Account-Link-Anfrage) Die zu signierende URL, unter der Annahme einer GET-Anfrage:

https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF

Diese URL hat die folgenden Parameter:

account_id = ABC, funding_instrument_id = DEF und status = OK

Die Basiszeichenkette, bestehend aus HTTP-Methode und URL ohne Parameter (Schritte a–d), sieht wie folgt aus:

GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“

Die Abfragezeichenfolge, erzeugt durch die Teilschritte von e, sieht wie folgt aus:

account_id=ABC&funding_instrument_id=DEF&status=OK

Die prozentcodierte Abfragezeichenfolge sieht wie folgt aus:

account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK

Die vollständige Basiszeichenkette, die die Schritte a–d und e kombiniert:

GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK

Mit dem Algorithmus hmac-sha1 signieren wir dies mit dem Wort „secret“ und der X-Benutzer-id, für die die ursprüngliche Link-Anfrage gestellt wurde, 1 (promotable_user_id = 1 von oben), als Schlüssel, „secret&1“.

Das Ergebnis wird Base64-codiert und ohne das abschließende „\n“ dargestellt (Schritte 2 und 3): jDSHDkHJIFXpPLVxtA3a9d4bPjM=

Diese Signatur wird dann (prozentsigniert) an das Ende der ursprünglichen URL im Parameter signature angehängt (Schritt 4):

https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D

​

Verwendung/Erneuerung gemeinsamer Schlüssel

Der Signaturalgorithmus sollte die Möglichkeit unterstützen, mit mehreren Schlüsseln zu arbeiten. Dadurch können mehrere gemeinsame Schlüssel verwendet und diese regelmäßig rotiert werden.  

​

Erstellung von partner_managed_funding_instrument

Wenn der Parameter fi_description angegeben ist und kein partner_managed_funding_instrument mit demselben Namen im Konto vorhanden ist, wird ein neues partner_managed_funding_instrument erstellt und alle vorhandenen partner_managed_funding_instruments werden pausiert.

Wenn ein partner_managed_funding_instrument mit demselben Namen vorhanden ist, wird kein neues erstellt.  

​

Wiederholte Onboarding-Flow-Aufrufe / Token-Aktualisierung

Der Onboarding-Flow kann wiederholt werden, falls das API Access Token verloren gegangen ist. Die Implementierung des Onboarding-Flows setzt voraus, dass der Benutzer angemeldet ist. Wenn der Benutzer mit der promotable_user_id übereinstimmt, das zugehörige Ads-Konto gefunden wird und alles in Ordnung ist, wird der Benutzer zurück zur Callback-URL umgeleitet, und der Partner kann den OAuth-Flow starten, um ein access token zu erhalten.  

​

Nicht-umleitbarer Fehlerfluss

Wenn die Konto-Verknüpfungs-URL mit ungültigen Parametern aufgerufen wird, wird dem Nutzer eine Seite angezeigt, die der im OAuth-Fluss gezeigten ähnelt, wenn ungültige oder abgelaufene Parameter übergeben wurden.  

​

Laufende Aktualisierungen des PMFI

Sobald der Werbetreibende eingebunden ist, kann das Finanzierungsinstrument ausschließlich von dem Partner verwaltet werden, der es betreut – über das endpoint PUT accounts/:account_id/funding_instruments/:funding_instrument_id.

​

Platzierungen

Es gibt mehrere Bereiche, in denen X-Anzeigen ausgeliefert werden können. Dies wird am Line Item über den Parameter placements festgelegt. Mögliche Werte sind:

• ALL_ON_TWITTER
• PUBLISHER_NETWORK
• TWITTER_PROFILE
• TWITTER_SEARCH
• TWITTER_TIMELINE
• SPOTLIGHT
• TREND

Das product_type und objective des Line Items bestimmen, welche Platzierungen zulässig sind. Der endpoint GET line_items/placements kann verwendet werden, um die gültigen Platzierungsoptionen für jeden Produkttyp abzurufen.

Zusätzlich führt die folgende Tabelle die gültigen Kombinationen aus Platzierung und Zielsetzung auf.

Zielsetzung	ALL_ON_TWITTER	TWITTER_PROFILE	TWITTER_SEARCH	TWITTER_TIMELINE
APP_ENGAGEMENTS	✔	✔	✔	✔
APP_INSTALLS	✔	✔	✔	✔
REACH	✔	✔	✔	✔
FOLLOWERS	✔	✔	✔	✔
ENGAGEMENTS	✔	✔	✔	✔
VIDEO_VIEWS	✔	✔	✔	✔
PREROLL_VIEWS	✔	✔	✔	✔
WEBSITE_CLICKS	✔	✔	✔	✔

Hinweis: Es ist nicht möglich, nur die Platzierung TWITTER_PROFILE anzugeben.

Hinweis: TWITTER_SEARCH erfordert Keyword-Targeting.

Hinweis: Die Zielsetzung REACH muss die Platzierung TWITTER_TIMELINE enthalten. Zulässig sind entweder ALL_ON_TWITTER, eine beliebige Kombination von Platzierungen, die TWITTER_TIMELINE einschließen, oder TWITTER_TIMELINE allein.

​

FAQ zu Anzeigengruppen

Dieses Dokument ist eine Sammlung häufig gestellter Fragen zu Anzeigengruppen in der Ads API von X.

​

Was ist eine Anzeigengruppe?

Anzeigengruppen, in der Ads API als Line Items bezeichnet, gehören zu Kampagnen und dienen dem Targeting sowie der Gebotsabgabe gegenüber einer Gruppe von X Nutzern. Werbetreibende bewerben Tweets oder Medien (z. B. Videos, die als In-Stream-Anzeigen geschaltet werden), indem sie diese einem Line Item zuordnen.

​

Wie erstellen wir eine Anzeigengruppe?

Anzeigengruppen werden erstellt, indem POST accounts/:account_id/line_items mehrfach für dieselbe Kampagnen-ID aufgerufen wird, wobei die (gegebenenfalls völlig unterschiedlichen) Zielausrichtungen und Tweets den jeweiligen Line Items zugeordnet bleiben. Es gilt ein Limit von 100 Line Items pro Kampagne und ein Limit von 200 aktiven Kampagnen pro Anzeigenkonto. Über alle Kampagnen hinweg gilt ein Limit von 8.000 aktiven Line Items pro Anzeigenkonto.

​

Warum sollten wir Unterstützung für Anzeigengruppen hinzufügen?

Anzeigengruppen sollen es Werbetreibenden erleichtern, ihre Kampagnen zu organisieren, zu optimieren und zu verwalten.

Der Vorteil von Anzeigengruppen besteht darin, unterschiedliche Strategien bei Gebot, Budget, Creatives und Targeting zu vergleichen und zu steuern. Wenn mehreren Promoted Tweets ein einzelnes Line Item zugeordnet wird, wählt die Auktion den besten Tweet aus dieser Gruppe und anschließend den besten Tweet für diese Kampagne aus allen Line Items. Wenn Sie mehrere Anzeigengruppen mit jeweils einzelnen Tweets haben, wird effektiv der Tweet ausgewählt, der aus dieser Anzeigengruppe voraussichtlich am besten performt.

Die Verwendung von Anzeigengruppen ermöglicht es Werbetreibenden, Targeting und Bidding in eine deutlich größere Anzahl möglicher Kombinationen aufzuteilen und das Targeting generell in logische Gruppen zu gliedern.

Insbesondere Tools für die Ads API könnten rund um fein abgestimmte Optimierungsregeln mit Anzeigengruppen aufgebaut werden, was aufgrund der größeren Anzahl von Line-Item- und Creative-Kombinationen durch manuelle Änderungen schwieriger umzusetzen wäre.

​

Wie verhält sich das Budget eines Line Items zum Kampagnenbudget in einer Ad-Gruppen-Kampagne?

Der Wert von total_budget_amount_local_micro für ein Line Item darf das Gesamtbudget der übergeordneten Kampagne nicht überschreiten. Ebenso sollte der bid_amount_local_micro-Wert des Line Items weder den daily_budget_amount_local_micro- noch den total_budget_amount_local_micro-Wert der übergeordneten Kampagne übersteigen. Eine falsche Konfiguration dieser Werte kann dazu führen, dass die gesamte Kampagne pausiert wird und nicht ausgeliefert werden kann.

Beachten Sie, dass das gesamte Kampagnenbudget geringer sein kann als die Summe der Budgets der untergeordneten Line Items. Die Verteilung des Budgets zwischen Line Items liegt teilweise im Ermessen des Ads API-Tools, um effektiv zu optimieren und anzupassen, da die tägliche Performance des Targetings (Line Item) aufgrund der Echtzeit-Natur von X von Tag zu Tag erheblich variieren kann.

​

Schneiden Anzeigengruppen besser ab als einzelne Line Items?

Die Leistung einer Kampagne hängt von vielen Faktoren ab; letztlich ist ein Tweet der ausschlaggebende Faktor für die Performance. Ein Line Item beeinflusst, ob ein Tweet überhaupt in die engere Auswahl kommt, einem Nutzer ausgeliefert zu werden.

Line Items, die auf dieselben Nutzersegmente abzielen, weisen eine Überschneidung von Nutzern auf. Es gilt als Best Practice, diese Überschneidungen im Targeting zwischen Line Items zu reduzieren, damit die leistungsstärksten Nutzersegmente klar identifiziert werden können.

​

Leitfäden

​

Ziel „Video Views Preroll“

Die folgende Anleitung beschreibt die Schritte, die erforderlich sind, um eine PREROLL_VIEWS-Kampagne in der Ads API einzurichten. Im Großen und Ganzen lassen sich diese Kampagnen in zwei Typen unterteilen: Curated Categories und Content Categories (in der Ads UI als „Standard Categories“ bezeichnet).  

​

Erforderliche Endpoints

• Chunked Media Upload (für Video-Uploads)
• POST accounts/:account_id/media_library (zur Zuordnung des Videos zum Ads-Konto)
• POST accounts/:account_id/campaigns (Kampagne erstellen)
• GET content_categories (Abruf der Zuordnung von Inhaltskategorien zu IAB-Kategorien)
• GET accounts/:account_id/curated_categories
• GET publishers
• POST accounts/:account_id/line_item_curated_categories
• POST accounts/:account_id/line_items (Anzeigengruppe erstellen)
• POST accounts/:account_id/media_creatives (zur Verknüpfung des Videos mit der Anzeigengruppe)
• POST accounts/:account_id/preroll_call_to_action (CTA und Weiterleitungs-URL festlegen)
• POST batch/accounts/:account_id/targeting_criteria (Targeting)

​

Schritte

​

Video hochladen

Das Hochladen des Videos umfasst zwei Schritte:

​

Videomaterial hochladen

Verwenden Sie zunächst das Endpoint Chunked media upload, um das Video zur Verarbeitung auf X hochzuladen. Beim initialen INIT über dieses Endpoint müssen Sie media_category=amplify_video übergeben. Laden Sie das Video in Teilstücken hoch. Sobald STATUS einen state-Wert von succeeded zurückgibt, können Sie mit den nächsten Schritten fortfahren. Weitere Informationen zum Hochladen von Medien über das Chunked-Endpoint finden Sie in unserer Promoted Video Overview.

​

Fügen Sie das Video dem Werbekonto hinzu

Sobald der mit dem Befehl STATUS zurückgegebene Status succeeded lautet, verwenden Sie den von diesem endpoint zurückgegebenen media_key, um das Video über den POST accounts/:account_id/media_library-endpoint zur Medienbibliothek des Werbetreibenden hinzuzufügen.

POST https://ads-api.x.com/8/55w3kv/media\_library?media\_key=3_931236738554519552

{
 "request": {
   "params": {
     "account_id": "55w3kv",
     "media\_key": "3\_931236738554519552"
   }
 },
 "data": {
   "tweeted": false,
   "name": null,
   "file_name": null,
   "media\_url": "https://video.twimg.com/amplify\_video/1059840836186165250/vid/568x320/Gr2l1fB1X7xotKwC.mp4?tag=8",
   "media\_category": "AMPLIFY\_VIDEO",
   "media\_key": "3\_931236738554519552",
   "created_at": "2017-11-16T19:05:14Z",
   "media\_status": "TRANSCODE\_COMPLETED",
   "media_id": 931236738554519552,
   "media_type": "VIDEO",
   "updated_at": "2017-11-16T19:05:23Z",
   "deleted": false
 }
}

​

Richten Sie die Kampagne ein

​

Kampagnenerstellung

Erstellen Sie die Kampagne sowie das Line Item/die Anzeigengruppe. Line Items sollten mit dem objective VIDEO_VIEWS_PREROLL und dem product_type MEDIA erstellt werden. Der Parameter categories muss außerdem auf die passenden Geschäftskategorien für Werbetreibende gesetzt werden.

POST https://ads-api.x.com/8/accounts/55w3kv/campaigns?name=test-curated-categories-api&funding\_instrument\_id=103hp9&start\_time=2021-02-10&entity\_status=PAUSED&daily\_budget\_amount\_local\_micro=55000000

{
  "request": {
    "params": {
      "name": "test-curated-categories-api",
      "start_time": "2021-02-10T00:00:00Z",
      "daily\_budget\_amount\_local\_micro": 55000000,
      "funding\_instrument\_id": "103hp9",
      "entity_status": "PAUSED",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
      "EXPIRED",
      "PAUSED\_BY\_ADVERTISER",
      "FUNDING_PROBLEM"
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "PAUSED",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "PAUSED",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

​

Erstellung von Line Items

Für Line Items muss der Parameter categories auf den passenden Satz von IAB-Kategorien gesetzt werden, der über den GET content_categories-endpoint abgerufen wird. Diese Inhaltskategorien entsprechen jeweils einer oder mehreren IAB-Kategorien.

Um diese Werte zu verwenden, müssen Partner eine geeignete Inhaltskategorie auswählen und den vollständigen Satz der in der Antwort zurückgegebenen iab_categories verwenden, um den Parameter categories am Line-Items-endpoint zu setzen. Jede teilweise Verwendung der iab_categories führt dazu, dass die gesamte Gruppe beim Line Item gesetzt wird. Zum Beispiel,

GET https://ads-api.x.com/8/advertiser\_business\_categories

{
  "request": {
    "params": {}
  },
  "next_cursor": null,
  "data": \[
    {
      "id": "1jl",
      "name": "Güter des täglichen Bedarfs",
      "iab_categories": \[
        "IAB9-26",
        "IAB9-18",
        "IAB9-29",
        "IAB9-1",
        "IAB9-8",
        "IAB9-22",
        "IAB6",
        "IAB9-5",
        "IAB9-12",
        "IAB9-11",
        "IAB9-23",
        "IAB9-14",
        "IAB4",
        "IAB9-25",
        "IAB9-17",
        "IAB23",
        "IAB9-24",
        "IAB9-13",
        "IAB16",
        "IAB9-4",
        "IAB9-9",
        "IAB9-20",
        "IAB22",
        "IAB9-28",
        "IAB9-27",
        "IAB9-16",
        "IAB9-31",
        "IAB9-3",
        "IAB9-19",
        "IAB10",
        "IAB9-2",
        "IAB9-6",
        "IAB9-21",
        "IAB9-10",
        "IAB9-15"
      \]
    },
    {
      "id": "1jm",
      "name": "Gesundheit & Pharma",
      "iab_categories": \[
        "IAB7"
      \]
    },
    {
      "id": "1jn",
      "name": "Alkohol",
      "iab_categories": \[
        "IAB8-5",
        "IAB8-18"
      \]
    },
    {
      "id": "1jo",
      "name": "Gastronomie",
      "iab_categories": \[
        "IAB8-10",
        "IAB8-8",
        "IAB8-7",
        "IAB8-15",
        "IAB8-3",
        "IAB8-4",
        "IAB8-1",
        "IAB8-16",
        "IAB8-12",
        "IAB8-13",
        "IAB8-17",
        "IAB8-11",
        "IAB8-6",
        "IAB8-9",
        "IAB8-2",
        "IAB8-14"
      \]
    },
    {
      "id": "1jp",
      "name": "Finanzdienstleistungen",
      "iab_categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \]
    },
    {
      "id": "1jq",
      "name": "Einzelhandel",
      "iab_categories": \[
        "IAB18"
      \]
    },
    {
      "id": "1jr",
      "name": "Reisen",
      "iab_categories": \[
        "IAB20"
      \]
    },
    {
      "id": "1js",
      "name": "Gaming",
      "iab_categories": \[
        "IAB9-30"
      \]
    },
    {
      "id": "1jt",
      "name": "Technologie",
      "iab_categories": \[
        "IAB19-22",
        "IAB19-13",
        "IAB19-4",
        "IAB19-33",
        "IAB19-26",
        "IAB19-3",
        "IAB19-16",
        "IAB19-9",
        "IAB19-32",
        "IAB19-25",
        "IAB19-30",
        "IAB19-36",
        "IAB19-21",
        "IAB5",
        "IAB19-12",
        "IAB19-28",
        "IAB19-17",
        "IAB19-8",
        "IAB19-7",
        "IAB19-24",
        "IAB15",
        "IAB19-11",
        "IAB19-31",
        "IAB19-20",
        "IAB19-15",
        "IAB19-1",
        "IAB19-35",
        "IAB19-29",
        "IAB19-34",
        "IAB19-23",
        "IAB19-2",
        "IAB19-5",
        "IAB19-14",
        "IAB19-27",
        "IAB19-10",
        "IAB19-19"
      \]
    },
    {
      "id": "1ju",
      "name": "Telekommunikation",
      "iab_categories": \[
        "IAB19-6",
        "IAB19-18"
      \]
    },
    {
      "id": "1jv",
      "name": "Automobil",
      "iab_categories": \[
        "IAB2"
      \]
    },
    {
      "id": "1jw",
      "name": "Medien & Unterhaltung",
      "iab_categories": \[
        "IAB14-8",
        "IAB14-4",
        "IAB1-5",
        "IAB14-7",
        "IAB1-7",
        "IAB17",
        "IAB14-3",
        "IAB1-1",
        "IAB12",
        "IAB1-6",
        "IAB25-1",
        "IAB1-2",
        "IAB14-2",
        "IAB14-6",
        "IAB1-3",
        "IAB1-4",
        "IAB14-5"
      \]
    },
    {
      "id": "1jx",
      "name": "Politik",
      "iab_categories": \[
        "IAB11-4"
      \]
    },
    {
      "id": "1jy",
      "name": "Glücksspiel",
      "iab_categories": \[
        "IAB9-7"
      \]
    },
    {
      "id": "1jz",
      "name": "Dating",
      "iab_categories": \[
        "IAB14-1"
      \]
    },
    {
      "id": "1k0",
      "name": "Gemeinnützig"
      "iab_categories": \[
        "IAB11-1",
        "IAB11-2",
        "IAB11-3",
        "IAB11-5"
      \]
    }
  \]
}

Um den Parameter categories auf “Science & Education” zu setzen, muss der vollständige Satz von iab_categories, also "IAB5", "IAB15", für das Line Item gesetzt werden, und zwar wie folgt:

POST https://ads-api.x.com/8/accounts/55w3kv/line_items?campaign_id=f2rp3&bid_amount_local_micro=5500000&name=curated-category-line-item&product_type=MEDIA&placements=ALL_ON_TWITTER&objective=PREROLL_VIEWS&categories=IAB3,IAB13,IAB21

{
  "request": {
    "params": {
      "name": "curated-category-line-item",
      "placements": \[
        "ALL\_ON\_TWITTER"
      \],
      "bid\_amount\_local_micro": 5500000,
      "product_type": "MEDIA",
      "objective": "PREROLL_VIEWS",
      "account_id": "55w3kv",
      "categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \],
      "campaign_id": "f2rp3"
    }
  },
  "data": {
    "bid_type": "MAX",
    "advertiser\_user\_id": 312226591,
    "name": "curated-category-line-item",
    "placements": \[
      "ALL\_ON\_TWITTER"
    \],
    "start_time": null,
    "bid\_amount\_local_micro": 5500000,
    "automatically\_select\_bid": false,
    "advertiser_domain": null,
    "target\_cpa\_local_micro": null,
    "raw_categories": \[
      "x",
      "5l",
      "9z"
    \],
    "primary\_web\_event_tag": null,
    "charge\_by": "VIEW\_3S_100PCT",
    "product\_type": "PROMOTED\_TWEETS",
    "end_time": null,
    "duration\_in\_days": null,
    "bid\_unit": "VIEW\_3S_100PCT",
    "total\_budget\_amount\_local\_micro": null,
    "objective": "PREROLL_VIEWS",
    "id": "iqwka",
    "entity_status": "ACTIVE",
    "automatic\_tweet\_promotion": null,
    "optimization": "DEFAULT",
    "frequency_cap": null,
    "android\_app\_store_identifier": null,
    "categories": \[
      "IAB3",
      "IAB13",
      "IAB21"
    \],
    "currency": "USD",
    "created_at": "2021-02-09T00:00:46Z",
    "tracking_tags": \[\],
    "ios\_app\_store_identifier": null,
    "amplify_config": {
      "auto_promote": true,
      "is_open": true
    },
    "updated_at": "2021-02-09T00:00:46Z",
    "campaign_id": "f2rp3",
    "creative_source": "MANUAL",
    "deleted": false
  }
}

​

Auswahl von Publishern

Ein Werbetreibender kann entweder eine Inhaltskategorie oder eine kuratierte Kategorie als Ziel auswählen; weitere Details sind unten beschrieben. 

Hinweis:  Line-Items können entweder kuratierte Kategorien oder Inhaltskategorien targeten, jedoch nicht beide. 

​

Kuratierte Kategorien

Kuratierte Kategorien ermöglichen es Werbetreibenden, eine vordefinierte Gruppe von Publishern anzusprechen und können über den endpoint GET curated_categories abgerufen werden. Diese Kategorien sind länderspezifisch und erfordern daher, dass das Line Item das entsprechende Land basierend auf dem country_code der Kategorie ausrichtet.

Um eine dieser Kategorien zu verwenden, sind die folgenden Schritte in der angegebenen Reihenfolge erforderlich:

1. Das Line Item muss das entsprechende Land basierend auf dem country_code der kuratierten Kategorie ausrichten
2. Der endpoint POST line_item_curated_categories muss verwendet werden, um das Line Item mit einer bestimmten curated_category_id zu verknüpfen.

Hinweis: Die Verknüpfung eines Line Items mit einer kuratierten Kategorie begrenzt auch die Anzahl der Publisher, die auf eine Denylist gesetzt werden können, auf 5. Die vollständige Liste der user_id, die verwendet werden, um bestimmte Publisher auf die Denylist zu setzen, kann über den endpoint GET publishers abgerufen werden. Zusätzlich darf ein gegebenes Line Item zu einem Zeitpunkt nicht mehr als eine kuratierte Kategorie ausrichten.

Das folgende Beispiel zeigt, wie eine kuratierte category id: b0xt, die nur in den USA verfügbar ist, mit dem im vorherigen Schritt erstellten Line Item verknüpft wird.

Zuerst wird das Targeting-Kriterium des Line Items auf den Wert 96683cc9126741d gesetzt

GET https://ads-api.x.com/8/targeting\_criteria/locations?country\_code=US&location_type=COUNTRIES

{
  "data": \[
    {
      "name": "Vereinigte Staaten",
      "country_code": "US",
      "location_type": "COUNTRIES",
      "targeting_value": "96683cc9126741d1",
      "targeting_type": "LOCATION"
    }
  \],
  "request": {
    "params": {
      "location_type": "COUNTRIES",
      "country_code": "US"
    }
  },
  "next_cursor": null
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwka",
      "targeting_type": "LOCATION",
      "targeting_value": "96683cc9126741d1",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "Vereinigte Staaten",
      "raw_negated": false,
      "raw\_targeting\_value": "2",
      "id": "rv9hmc",
      "raw\_targeting\_type": "GEO",
      "raw\_operator\_type": "EQUAL_TO",
      "location_type": "COUNTRIES",
      "operator_type": "EQ",
      "created_at": "2021-02-09T00:06:28Z",
      "targeting_value": "96683cc9126741d1",
      "updated_at": "2021-02-09T00:06:28Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "96683cc9126741d1",
        "targeting_type": "LOCATION"
      },
      "operation_type": "Create"
    }
  \]
}

POST https://ads-api.x.com/8/accounts/55w3kv/line\_item\_curated\_categories?line\_item\_id=iqwka&curated\_category_id=9ddrgesiap6o

{
  "request": {
    "params": {
      "curated\_category\_id": "9ddrgesiap6o",
      "line\_item\_id": "iqwka",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "line\_item\_id": "iqwka",
    "curated\_category\_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T17:26:42Z",
    "deleted": false
  }
}

​

Inhaltskategorien

Inhaltskategorien, auch als Standardkategorien bezeichnet, können über den endpoint GET curated_categories abgerufen werden. Diese Kategorien können anschließend vom Line Item mithilfe der batch Targetingkriterien endpoints gezielt angesprochen werden. Das folgende Beispiel zeigt, wie eine bestimmte Inhaltskategorie mit der id: sr ausgewählt wird, die „News & Current Events“ zugeordnet ist, und wie sie auf das Line Item angewendet wird.

Hinweis: Der gesamte Satz der iab_categories in der GET curated_categories-Antwort muss über das Targetingkriterien endpoint adressiert werden. Andernfalls führt dies zu einem Validierungsfehler. 

GET https://ads-api.x.com/8/content_categories
{
      "name": "Nachrichten & Aktuelles",
      "id": "sr",
      "iab_categories": \[
        "IAB12",
        "IAB14"
      \],
      "publishers\_in\_last\_thirty\_days": 124,
      "videos\_monetized\_in\_last\_thirty_days": 5429
    }
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB12",
      "operator_type": "EQ"
    }
  },
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB14",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwls",
      "name": "Nachrichten",
      "raw_negated": false,
      "raw\_targeting\_value": "5h",
      "id": "saib9p",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB12",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    },
    {
      "line\_item\_id": "iqwls",
      "name": "Gesellschaft"
      "raw_negated": false,
      "raw\_targeting\_value": "5y",
      "id": "saib9q",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB14",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB12",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB14",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    }
  \]
}

Verknüpfen Sie die Medien des Kontos (Video) mit dem Line Item

Verwenden Sie das endpoint POST accounts/:account_id/media_creatives, um das Video mit einer Anzeigengruppe zu verknüpfen.

POST https://ads-api.x.com/8/accounts/55w3kv/media_creatives
line\_item\_id=4bii5&account\_media\_id=knb

{
 "data":{
   "account\_media\_id":"74g",
   "approval_status":"AKZEPTIERT",
   "created_at":"2016-02-11T22:23:23Z",
   "deleted":false,
   "id":"qeq",
   "landing_url":null,
   "line\_item\_id":"4bii5",
   "serving_status":"AKTIV"
   "updated_at":"2016-02-11T22:23:23Z"
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "account\_media\_id":"knb"
   }
 }
}

​

Legen Sie die CTA und die Ziel-URL fest

Es ist wichtig zu beachten, dass im Gegensatz zu den meisten anderen Kampagnen auf X das Ziel VIDEO_VIEWS_PREROLL keine Promoted Tweets oder Cards verwendet. Stattdessen wird das Video-Creative Ihrer Anzeigengruppe (Line Item) zugeordnet und die CTA-Informationen einer preroll_call_to_action-Entität. Das Endpoint POST accounts/:account_id/preroll_call_to_action ermöglicht es Ihnen, die CTA-Schaltfläche und die Ziel-URL zu steuern.

POST https://ads-api.x.com/8/accounts/55w3kv/preroll\_call\_to_action
line\_item\_id=4bii5&call\_to\_action=VISIT\_SITE&call\_to\_action\_url=https%3A%2F%2Fx.com%2FAdsAPI

{
 "data":{
   "id":"aaa111",
   "line\_item\_id":"4bii5",
   "call\_to\_action":"JETZT_ANSEHEN",
   "call\_to\_action_url":"https://x.com/AdsAPI",
   "created_at":"2016-02-11T22:23:23Z",
   "updated_at":"2016-02-11T22:23:23Z",
   "deleted":false
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "call\_to\_action":"SEITE_BESUCHEN",
     "call\_to\_action_url":"https://x.com/AdsAPI"
   }
 }
}

​

Zielkriterien festlegen

Das für Pre‑Roll‑Videoanzeigen verwendete Zielkriterium ist nur über unseren Batch‑Targeting‑Kriterien‑endpoint POST batch/accounts/:account_id/targeting_criteria verfügbar.

Verwenden Sie CONTENT_PUBLISHER_USER als negiertes Targeting, um die Anzeige von einer Gruppe von Nutzern auszuschließen. Geben Sie die X‑user_id oder die publisher_user_id für die auszuschließenden Handles an.

Der GET publishers-endpoint kann verwendet werden, um die Liste der auszuschließenden user_id für Content-Kategorien abzurufen. Die in der Antwort von GET curated_categories zurückgegebene publisher_user_id kann verwendet werden, um eine ähnliche Ausschlussliste für kuratierte Kategorien abzurufen.

Hinweis: Für kuratierte Kategorien können maximal 5 publisher_user_id und für Content-Kategorien 50 user_id ausgeschlossen werden.

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "CONTENT\_PUBLISHER_ID",
      "targeting_value": "1917731",
      "operator_type": "NE"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "realsaltlake",
      "raw_negated": true,
      "raw\_targeting\_value": "aajwo",
      "id": "sajk32",
      "raw\_targeting\_type": "CONTENT_PUBLISHER",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "NE",
      "created_at": "2021-03-30T18:02:32Z",
      "targeting_value": 17288520,
      "updated_at": "2021-03-30T18:02:32Z",
      "deleted": false,
      "targeting\_type": "CONTENT\_PUBLISHER_USER"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "NE",
        "targeting_value": "17288520",
        "targeting\_type": "CONTENT\_PUBLISHER_USER"
      },
      "operation_type": "Create"
    }
  \]
}

​

Kampagne starten

Wenn Sie bereit sind, Ihre Kampagne zu starten, heben Sie die Pause einfach auf, indem Sie PUT accounts/:account_id/campaigns/:id verwenden.

PUT https://ads-api.x.com/8/accounts/55w3kv/campaigns/f2rp3? entity_status=ACTIVE

{
  "request": {
    "params": {
      "campaign_id": "f2rp3",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons_not_servable": [
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "ACTIVE",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "ACTIVE",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

​

Analytics

Analysen für VIDEO_VIEWS_PREROLL-Kampagnen sind über unsere Stats-endpoints verfügbar.

​

Keyword-Targeting in Timelines

Keyword-Targeting ist grundlegend für unsere Promoted-Tweets-Produkte und verschafft Kampagnen eine größere Reichweite. Keyword-Targeting in der Timeline ermöglicht es Plattformen, X-Nutzer basierend auf Schlüsselwörtern in ihren jüngsten Tweets anzusprechen. Wenn beispielsweise ein Werbetreibender die ungeordnete Schlüsselwortkombination „plan + trip“ verwendet und ein Nutzer tweetet: „I’m starting to plan my trip to Cabo, any suggestions?“, während die Kampagne läuft, kann dieser Nutzer kurz darauf den Promoted Tweet des Werbetreibenden sehen.

​

Wie funktioniert das?

TL;DR: Aus API-Sicht ist diese Änderung recht einfach: Sie können jetzt Keywords für Promoted Tweets in der Timeline targeten. Setzen Sie dazu bei Line Items den targeting_type auf unordered_keywords oder phrase_keywords.

​

Schnellstart-Anleitung

• Erstellen Sie ein neues Line Item mit der Platzierung ALL_ON_TWITTER oder TWITTER_TIMELINE. POST accounts/:account_id/line_items
• Legen Sie die Targeting-Kriterien für dieses neu erstellte Line Item mit BROAD_KEYWORD fest und definieren Sie Ihre Keyword-Werte. POST accounts/:account_id/targeting_criteria
• Sie können die Keywords mit PUT accounts/:account_id/targeting_criteria aktualisieren.
• Sobald Ihre Kampagne läuft, rufen Sie die Statistiken für Ihr Line Item ab, um die Leistung zu bewerten. GET stats/accounts/:account_id

​

API-Referenz

​

Accounts

In Postman öffnen

​

GET accounts

Rufen Sie Details für einige oder alle werbefähigen Accounts ab, auf die der authentifizierende Benutzer Zugriff hat.

Resource URL

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

Parameters

Name	Beschreibung
account_ids optional	Beschränken Sie die Antwort auf die gewünschten Account-IDs, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Type: string Beispiel: 18ce54d4x5t
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: 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. Type: string Beispiel: 8x7v00oow
q optional	Eine optionale Abfrage, um die Ressource nach name einzuschränken. Hinweis: Dies führt eine groß-/kleinschreibungsunabhängige Präfixübereinstimmung durch. Type: string Min-, Max-Länge: 1, 255
sort_by optional	Sortiert nach einem unterstützten Attribut in aufsteigender oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Beispiel: created_at-asc
with_deleted optional	Schließt gelöschte Ergebnisse in Ihre Anfrage ein. Type: 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. Type: boolean Standard: false Mögliche Werte: true, false

​

Beispielanfrage

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

Beispielantwort

       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
           {
             "name": "API McTestface",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": "2016-07-21T07:00:00Z",
             "id": "18ce54d4x5t",
             "created_at": "2016-07-21T22:42:09Z",
             "updated_at": "2017-07-06T16:51:04Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

​

GET accounts/:account_id

Rufen Sie ein bestimmtes Konto ab, auf das der authentifizierte Nutzer Zugriff hat.

Resource URL

https://ads-api.x.com/12/accounts/:account_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
with_deleted optional	Schließen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Default: false Possible values: true, false

Example Request

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

Example Response

       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
           }
         },
         "data": {
           "name": "API McTestface",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TRAVEL",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

​

POST accounts

Hinweis: NUR SANDBOX

Erstellen Sie ein Ads-Konto in der Sandboxumgebung.

Resource URL

https://ads-api-sandbox.x.com/12/accounts

Parameters

Keine

Example Request

POST https://ads-api-sandbox.x.com/12/accounts

Example Response

       {
         "request": {
           "params": {}
         },
         "next_cursor": null,
         "data": [
           {
             "name": "Sandbox-Konto",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": null,
             "id": "gq12fh",
             "created_at": "2016-07-18T23:02:20Z",
             "updated_at": "2016-07-18T23:02:20Z",
             "business_id": null,
             "approval_status": "ACCEPTED"
             "deleted": false
           }
         ]
       }

​

PUT accounts/:account_id

Aktualisiert den Kontonamen und/oder die Branchenzuordnung.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
name optional	Der Kontoname. Type: string Example: API McTestface
industry_type optional	Branche, der das Konto zugeordnet ist. Type: string Possible values: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER

Beispielanforderung

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY

Beispielantwort

       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
             "name": "API McTestface 2",
             "industry_type": "TECHNOLOGY"
           }
         },
         "data": {
           "name": "API McTestface 2",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TECHNOLOGY",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

​

DELETE accounts/:account_id

Hinweis: NUR SANDBOX

Löscht ein Ads-Konto in der Sandbox-Umgebung.

Ressourcen-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t

Beispielanfrage

DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh

Beispielantwort

       {
         "data": {
           "name": "Sandbox-Konto",
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": null,
           "id": "gq12fh",
           "created_at": "2016-07-18T23:02:20Z",
           "updated_at": "2017-08-23T18:21:10Z",
           "approval_status": "ACCEPTED"
           "deleted": true
         },
         "request": {
           "params": {
             "account_id": "gq12fh"
           }
         }
       }

​

Account-Apps

In Postman öffnen ❯

​

GET account_apps

Ruft Details zu allen mobilen Apps ab, die dem angegebenen Werbekonto zugeordnet sind.

Resource URL

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

Parameters

Name	Description
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
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abzurufen sind. Type: int Default: 200 Min, Max: 1, 1000
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließt das Antwortattribut total_count ein. Note: Dieser Parameter und cursor schließen sich gegenseitig aus. Note: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

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

Example Response

       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
          {
            "app_store_identifier": "com.twitter.android",
            "conversion_tracking_enabled": false,
            "deep_link_pattern": "twitter://",
            "id": "4x",
            "created_at": "2019-06-20T22:36:16Z",
            "updated_at": "2021-10-19T20:05:29Z",
            "os_type": "Android",
            "deleted": false
          }
         ]
       }

​

Kontoverlauf

In Postman öffnen

​

GET accounts/:account_id/account_history

Rufen Sie eine Zusammenfassung der Änderungen ab, die an der in der Anfrage angegebenen entity_id vorgenommen wurden.

Hinweis: Dieser Endpoint befindet sich derzeit in der Beta-Phase und erfordert Allowlisting.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Typ: string Beispiel: 18ce54d4x5t
count optional	Gibt die Anzahl der Datensätze an, die pro 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
entity_type erforderlich	Der Entitätstyp, für den Daten abgerufen werden sollen. Typ: enum Beispiel: PROMOTED_TWEET Mögliche Werte: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT
entity_id erforderlich	Die spezifische Entität, für die Daten abgerufen werden sollen. Typ: string Beispiel: 8u94t
start_time erforderlich	Beschränkt die abgerufenen Daten auf die angegebene Startzeit, ausgedrückt in ISO 8601. Hinweis: Muss in ganzen Stunden angegeben werden (0 Minuten und 0 Sekunden). Typ: string Beispiel: 2017-05-19T07:00:00Z
end_time erforderlich	Beschränkt die abgerufenen Daten auf die angegebene Endzeit, ausgedrückt in ISO 8601. Hinweis: Muss in ganzen Stunden angegeben werden (0 Minuten und 0 Sekunden). Typ: string Beispiel: 2017-05-26T07:00:00Z
user_id optional	Beschränkt die Antwort auf einen bestimmten Nutzer. Typ: long Beispiel: 3271358660

Beispielanfrage

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "entity": "CAMPAIGN",
          "entity_id": "fc3h5",
          "count": 1
        }
      },
      "next_cursor": "1r2407sb4lc",
      "data": [
        {
          "change_by": {
            "user_id": "982978172",
            "platform": "API_OTHER"
          },
          "changes": {},
          "change_time": "2021-04-02T20:55:42Z",
          "entity_id": "fc3h5",
          "entity": "CAMPAIGN",
            "name": "test_campaign",
            "name": "test_campaign",
            "start_time": "2021-04-02T18:59:11Z",
            "purchase_order_number": null,
            "daily_budget_amount_local_micro": 100000000,
            "end_time": null,
            "duration_in_days": null,
            "standard_delivery": true,
            "total_budget_amount_local_micro": 100000000,
            "entity_status": "ACTIVE",
            "frequency_cap": null,
            "created_at": "2021-04-02T20:55:42Z",
            "updated_at": "2021-04-02T20:55:42Z",
            "deleted": false
          },
          "change_type": "CREATE"
        }
      ]
    }

​

Geschäftskategorien für Werbetreibende

In Postman öffnen

​

GET advertiser_business_categories

Fordern Sie die gültigen geschäftlichen categories für Werbetreibende für Anzeigengruppen (line_items) an, um die Marke eines Werbetreibenden gegenüber Publishern zu beschreiben.

Hinweis: Diese Kategorien gelten nur für line_items mit dem Ziel PREROLL_VIEWS und sind getrennt von den content_categories, die für Targeting-Kriterien verwendet werden.

Jede advertiser_business_categories steht für eine Sammlung von IAB-Kategorien. Beim Erstellen einer Anzeigengruppe mit dem Ziel PREROLL_VIEWS müssen ein oder zwei advertiser_business_categories für die Anzeigengruppe festgelegt werden. Dies kann erfolgen, indem der Wert des Anfrageparameters categories am line item-endpoint auf die Menge der entsprechenden iab_categories gesetzt wird, die über diesen endpoint verfügbar sind.

Weitere Details finden Sie im Leitfaden zum Ziel „Video Views Preroll“

Resource URL

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

Parameters

Keine Anfrageparameter

Example Request

GET https://ads-api.x.com/12/advertiser_business_categories

Example Response

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "id": "1jl",
          "name": "Konsumgüter",
          "iab_categories": [
            "IAB9-26",
            "IAB9-18",
            "IAB9-29",
            "IAB9-1",
            "IAB9-8",
            "IAB9-22",
            "IAB6",
            "IAB9-5",
            "IAB9-12",
            "IAB9-11",
            "IAB9-23",
            "IAB9-14",
            "IAB4",
            "IAB9-25",
            "IAB9-17",
            "IAB23",
            "IAB9-24",
            "IAB9-13",
            "IAB16",
            "IAB9-4",
            "IAB9-9",
            "IAB9-20",
            "IAB22",
            "IAB9-28",
            "IAB9-27",
            "IAB9-16",
            "IAB9-31",
            "IAB9-3",
            "IAB9-19",
            "IAB10",
            "IAB9-2",
            "IAB9-6",
            "IAB9-21",
            "IAB9-10",
            "IAB9-15"
          ]
        },
        {
          "id": "1jm",
          "name": "Gesundheit & Pharmazie",
          "iab_categories": [
            "IAB7"
          ]
        },
        {
          "id": "1jn",
          "name": "Alkohol",
          "iab_categories": [
            "IAB8-5",
            "IAB8-18"
          ]
        },
        {
          "id": "1jo",
          "name": "Gastronomie",
          "iab_categories": [
            "IAB8-10",
            "IAB8-8",
            "IAB8-7",
            "IAB8-15",
            "IAB8-3",
            "IAB8-4",
            "IAB8-1",
            "IAB8-16",
            "IAB8-12",
            "IAB8-13",
            "IAB8-17",
            "IAB8-11",
            "IAB8-6",
            "IAB8-9",
            "IAB8-2",
            "IAB8-14"
          ]
        },
        {
          "id": "1jp",
          "name": "Finanzdienstleistungen",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ]
        },
        {
          "id": "1jq",
          "name": "Einzelhandel",
          "iab_categories": [
            "IAB18"
          ]
        },
        {
          "id": "1jr",
          "name": "Reisen",
          "iab_categories": [
            "IAB20"
          ]
        },
        {
          "id": "1js",
          "name": "Gaming",
          "iab_categories": [
            "IAB9-30"
          ]
        },
        {
          "id": "1jt",
          "name": "Technologie",
          "iab_categories": [
            "IAB19-22",
            "IAB19-13",
            "IAB19-4",
            "IAB19-33",
            "IAB19-26",
            "IAB19-3",
            "IAB19-16",
            "IAB19-9",
            "IAB19-32",
            "IAB19-25",
            "IAB19-30",
            "IAB19-36",
            "IAB19-21",
            "IAB5",
            "IAB19-12",
            "IAB19-28",
            "IAB19-17",
            "IAB19-8",
            "IAB19-7",
            "IAB19-24",
            "IAB15",
            "IAB19-11",
            "IAB19-31",
            "IAB19-20",
            "IAB19-15",
            "IAB19-1",
            "IAB19-35",
            "IAB19-29",
            "IAB19-34",
            "IAB19-23",
            "IAB19-2",
            "IAB19-5",
            "IAB19-14",
            "IAB19-27",
            "IAB19-10",
            "IAB19-19"
          ]
        },
        {
          "id": "1ju",
          "name": "Telekommunikation",
          "iab_categories": [
            "IAB19-6",
            "IAB19-18"
          ]
        },
        {
          "id": "1jv",
          "name": "Automobil",
          "iab_categories": [
            "IAB2"
          ]
        },
        {
          "id": "1jw",
          "name": "Medien & Unterhaltung",
          "iab_categories": [
            "IAB14-8",
            "IAB14-4",
            "IAB1-5",
            "IAB14-7",
            "IAB1-7",
            "IAB17",
            "IAB14-3",
            "IAB1-1",
            "IAB12",
            "IAB1-6",
            "IAB25-1",
            "IAB1-2",
            "IAB14-2",
            "IAB14-6",
            "IAB1-3",
            "IAB1-4",
            "IAB14-5"
          ]
        },
        {
          "id": "1jx",
          "name": "Politik",
          "iab_categories": [
            "IAB11-4"
          ]
        },
        {
          "id": "1jy",
          "name": "Glücksspiel",
          "iab_categories": [
            "IAB9-7"
          ]
        },
        {
          "id": "1jz",
          "name": "Dating",
          "iab_categories": [
            "IAB14-1"
          ]
        },
        {
          "id": "1k0",
          "name": "Gemeinnützige Organisationen"
          "iab_categories": [
            "IAB11-1",
            "IAB11-2",
            "IAB11-3",
            "IAB11-5"
          ]
        }
      ]
    }

​

Zielgruppenschätzung

In Postman öffnen

POST accounts/:account_id/audience_estimate

​

Bestimmen Sie die ungefähre Zielgruppengröße Ihrer Kampagnen.

Dieses endpoint akzeptiert ein Array von JSON-Objekten, das die Parameter für die Targeting-Kriterienobjekte enthält. Eine Liste der erforderlichen und optionalen Targeting-Kriterienparameter ist am endpoint POST accounts/:account_id/targeting_criteria verfügbar. Anfragen müssen per HTTP POST mit einem JSON-Request-Body und dem Header Content-Type: application/json erfolgen.

Hinweis: Sie müssen mindestens ein primäres Targeting-Kriterium angeben; eine Liste aller primären Targeting-Kriterien finden Sie auf unserer Seite Kampagnen-Targeting.

Resource URL

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

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
targeting_criteria erforderlich	Ein JSON-Objekt, das alle Parameter für die Targeting-Kriterienobjekte enthält. Eine Liste der erforderlichen und optionalen Targeting-Kriterienparameter ist am endpoint POST accounts/:account_id/targeting_criteria verfügbar.
operator_type optional	Gibt die Beziehung an, die das Targeting-Kriterium haben soll. Um beispielsweise negiertes Targeting festzulegen, verwenden Sie operator_type=NE. Type: enum Possible values: EQ, NE Default: EQ

Example Request

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate

    {
        "targeting_criteria": [
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "nba",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "tech"
                "operator_type": "NE"
            },
            {
                "targeting_type": "LOCATION",
                "targeting_value": "96683cc9126741d1",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "14230524"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "90420314"
            }
        ]
    }

Beispielantwort

    {
      "request": {
        "params": {
          "targeting_criteria": null,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "audience_size": {
          "min": 38236294,
          "max": 42261167
        }
      }
    }

​

Authentifizierter Zugriff für Benutzer

In Postman öffnen

​

GET accounts/:account_id/authenticated_user_access

Rufen Sie die Berechtigungen des aktuell authentifizierten Nutzers (access_token) in Bezug auf das angegebene Ads-Konto ab. Diese Berechtigungen entsprechen denen auf ads.x.com.

Mögliche Werte sind:

• ACCOUNT_ADMIN: Vollzugriff zum Ändern von Kampagnen und Anzeigen von Statistiken, einschließlich der Möglichkeit, Nutzer hinzuzufügen oder zu entfernen sowie Einstellungen zu ändern
• AD_MANAGER: Vollzugriff zum Ändern von Kampagnen und Anzeigen von Statistiken, kann jedoch keine Nutzer hinzufügen oder entfernen und keine Einstellungen ändern
• CREATIVE_MANAGER: Zugriff zum Ändern von Creatives und Anzeigen von Vorschauen, jedoch kein Zugriff zum Erstellen oder Ändern von Kampagnen
• CAMPAIGN_ANALYST: Zugriff zum Anzeigen von Kampagnen und Statistiken, jedoch kein Zugriff zum Erstellen oder Ändern von Kampagnen
• ANALYST („Organic Analyst“ auf ads.x.com): Zugriff zum Anzeigen von organischen Analysen und Zielgruppen-Insights, jedoch kein Zugriff zum Erstellen, Ändern oder Anzeigen von Kampagnen
• PARTNER_AUDIENCE_MANAGER: API-only-Zugriff zum Anzeigen und Ändern von Datenpartner-Zielgruppen, jedoch kein Zugriff auf Kampagnen, Creatives oder andere Zielgruppentypen.

Zusätzlich zeigt die Berechtigung TWEET_COMPOSER an, dass der authentifizierte Nutzer im Namen des Werbetreibenden nullcasted (bzw. „Promoted-only“) Tweets erstellen kann. Dies ist nur für Nutzer mit ACCOUNT_ADMIN-, AD_MANAGER- oder CREATIVE_MANAGER-Zugriff verfügbar.

Resource URL

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

Parameters

Keine

Example Request

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

Example Response

    {
      "data": {
        "user_id": "2417045708",
        "permissions": [
          "ACCOUNT_ADMIN",
          "TWEET_COMPOSER"
        ]
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Gebotsregeln

In Postman öffnen

​

GET bidding_rules

Rufen Sie die Gebotsregeln für bestimmte oder alle Währungen ab. Die Antwort enthält die minimalen und maximalen CPE-Gebote (Cost-per-Engagement).

Auch wenn sich diese Gebotsregeln nur selten ändern, sollten Ihre Systeme diese Endpoints mindestens monatlich aktualisieren.

Resource URL

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

Parameters

Name	Description
currency optional	Der Typ einer Währung, nach dem die Ergebnisse gefiltert werden, identifiziert gemäß ISO-4217. Dies ist eine dreibuchstabige Zeichenfolge wie „USD“ oder „EUR“. Lassen Sie diesen Parameter weg, um alle Gebotsregeln abzurufen. Type: string Example: USD

Example Request

GET https://ads-api.x.com/12/bidding_rules?currency=USD

Example Response

    {
      "request": {
        "params": {
          "currency": "USD"
        }
      },
      "data_type": "bidding_rule",
      "data": [
        {
          "currency": "USD",
          "minimum_cpe_bid_local_micro": 10000,
          "maximum_cpe_bid_local_micro": 1000000000,
          "minimum_denomination": 10000
        }
      ],
      "total_count": 1
    }

​

Kampagnen

In Postman öffnen

​

GET accounts/:account_id/campaigns

Rufen Sie Details für einige oder alle Kampagnen ab, die dem aktuellen Account zugeordnet sind.

Resource URL

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

Parameters

Name	Beschreibung
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
campaign_ids optional	Beschränken Sie die Antwort auf die gewünschten Kampagnen, indem Sie eine kommaseparierte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übermittelt werden. Type: string Example: 8wku2
count optional	Gibt die Anzahl der Datensätze an, die pro 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
funding_instrument_ids optional	Beschränken Sie die Antwort auf Kampagnen unter bestimmten Finanzierungsinstrumenten, indem Sie eine kommaseparierte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übermittelt werden. Type: string Example: lygyi
q optional	Eine optionale Abfrage, um die Ressource nach name zu filtern. Type: string Min, Max length: 1, 255
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Default: false Possible values: true, false
with_draft optional	Schließen Sie Ergebnisse von Entwurfskampagnen in Ihre Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließen Sie das Antwortattribut total_count ein. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen mit total_count unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2

Example Response

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "campaign_ids": [
            "8wku2"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "test",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 10000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8wku2",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z"
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/campaigns/:campaign_id

Ruft eine bestimmte Kampagne ab, die dem aktuellen Account zugeordnet ist.

Resource URL

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

Parameters

Name	Description
account_id required	Der Bezeichner des verwendeten Accounts. Erscheint im Pfad der Ressource 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
campaign_id required	Die Referenz auf die Kampagne, auf die sich die Anfrage bezieht. Type: string Example: 8wku2
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/campaigns/8wku2

Example Response

    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 10000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

​

POST accounts/:account_id/campaigns

Erstellen Sie eine neue Kampagne, die dem aktuellen Konto zugeordnet ist.

Hinweis: Es gibt ein Standardlimit von 200 aktiven Kampagnen pro Konto. Es gibt jedoch kein Limit für die Anzahl inaktiver Kampagnen. Dieses Limit kann auf 8.000 aktive Kampagnen erhöht werden. Um das höhere Limit zu aktivieren, muss der Werbetreibende eine Anfrage an seinen X Account Manager stellen.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
funding_instrument_id erforderlich	Der Bezeichner für das Funding Instrument, unter dem die Kampagne erstellt werden soll. Type: string Example: lygyi
name erforderlich	Der Name der Kampagne. Maximale Länge: 255 Zeichen. Type: string Example: demo
budget_optimization optional	Wählen Sie die Art der Budgetoptimierung, die angewendet werden soll. Type: enum Default: CAMPAIGN Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro manchmal erforderlich	Der tägliche Budgetbetrag, der der Kampagne zugewiesen wird. Die Währung, die dem angegebenen Funding Instrument zugeordnet ist, wird verwendet. Für USD wird 5,50 $ als 5500000 dargestellt. Hinweis: Dieser Wert sollte kleiner oder gleich total_budget_amount_local_micro sein und ist für die meisten Funding-Instrument-Typen erforderlich. Type: long Example: 5500000
entity_status optional	Der Kampagnenstatus. Type: enum Default: ACTIVE Possible values: ACTIVE, DRAFT, PAUSED
purchase_order_number optional	Die Buchungsreferenznummer. Verwenden Sie dieses Feld zur Unterstützung bei der Rechnungsabstimmung. Maximale Länge: 50 Zeichen. Type: string Example: D00805843
standard_delivery optional	Standard- oder beschleunigte Auslieferung aktivieren. Siehe Budget Pacing für weitere Informationen zu Standard- versus beschleunigter Auslieferung. Nur verfügbar, wenn budget_optimization auf CAMPAIGN gesetzt ist. Type: boolean Default: true Possible values: true, false
total_budget_amount_local_micro optional	Der gesamte Budgetbetrag, der der Kampagne zugewiesen wird. Die Währung, die dem angegebenen Funding Instrument zugeordnet ist, wird verwendet. Für USD wird 37,50 $ als 37500000 dargestellt. Type: long Example: 37500000

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false

Beispielantwort

    {
      "request": {
        "params": {
          "name": "demo",
          "budget_optimization": "CAMPAIGN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "standard_delivery": false,
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "demo",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "hwtbm",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

​

POST batch/accounts/:account_id/campaigns

Ermöglicht die stapelweise Erstellung neuer Kampagnen mit einer einzigen Anfrage.

Batch-Anfragen

• Die aktuelle maximale Batchgröße beträgt 40.
• Alle Parameter werden im Request-Body gesendet; ein Content-Type von application/json ist erforderlich.
• Batch-Anfragen schlagen als Gruppe fehl oder sind als Gruppe erfolgreich; alle API-Antworten für Fehler und Erfolg erhalten 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 Batchgröße überschritten) werden in der Antwort im Objekt errors angezeigt.
• Fehler auf Elementebene (z. B. erforderlicher Kampagnenparameter fehlt) werden in der Antwort im Objekt operation_errors angezeigt.

Resource-URL

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

Parameter

Name	Beschreibung
operation_type erforderlich	Der je Element ausgeführte Operationstyp. Type: enum Mögliche Werte: Create, Delete, Update
params erforderlich	Ein JSON-Objekt mit allen Parametern für die Kampagnenobjekte. Eine Liste der erforderlichen und optionalen Kampagnenparameter finden Sie hier.

Beispielanfrage

POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns

    [
      {
        "operation_type":"Create",
        "params":{
          "name":"Batchkampagnen",
          "funding_instrument_id":"lygyi",
          "daily_budget_amount_local_micro":140000000,
          "entity_status":"PAUSED",
          "budget_optimization":"CAMPAIGN"
        }
      }
    ]

Beispielantwort

    {
      "data": [
        {
          "name": "Batchkampagnen",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8yn7m",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "name": "Batchkampagnen",
            "funding_instrument_id": "lygyi",
            "daily_budget_amount_local_micro": 140000000,
            "entity_status": "PAUSED",
            "budget_optimization":"CAMPAIGN",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        }
      ]
    }

​

PUT accounts/:account_id/campaigns/:campaign_id

Aktualisieren Sie die angegebene Kampagne, die dem aktuellen Konto zugeordnet ist.

Resource-URL

https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_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
campaign_id erforderlich	Referenz auf die Kampagne, auf die sich die Anfrage bezieht. Type: string Example: 8wku2
budget_optimization optional	Wählen Sie die Art der Budgetoptimierung, die angewendet werden soll. Type: enum Default: CAMPAIGN Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro optional	Der tägliche Budgetbetrag, der der Kampagne zugewiesen wird. Es wird die Währung des angegebenen Finanzierungsinstruments verwendet. Für USD wird $5.50 als 5500000 dargestellt. Wenn nicht angegeben, wird das Budget gleichmäßig über die gesamte Kampagnenlaufzeit anhand des Gesamtbudgets verteilt. Hinweis: Dieser Wert sollte kleiner oder gleich total_budget_amount_local_micro sein. Type: long Example: 5500000
entity_status optional	Der Status der Kampagne. Type: enum Possible values: ACTIVE, PAUSED
name optional	Der Name der Kampagne. Maximale Länge: 255 Zeichen. Type: string Example: demo
purchase_order_number optional	Die Bestellreferenznummer. Verwenden Sie dieses Feld zur Unterstützung bei der Rechnungsabstimmung. Maximale Länge: 50 Zeichen. Type: string Example: D00805843
standard_delivery optional	Standard- oder beschleunigte Auslieferung aktivieren. Siehe Budget Pacing für weitere Informationen zu Standard- versus beschleunigter Auslieferung. Nur verfügbar, wenn budget_optimization auf CAMPAIGN gesetzt ist. Type: boolean Default: true Possible values: true, false
total_budget_amount_local_micro optional	Der gesamte Budgetbetrag, der der Kampagne zugewiesen wird. Es wird die Währung des angegebenen Finanzierungsinstruments verwendet. Für USD wird $37.50 als 37500000 dargestellt. Type: long Example: 140000000

Beispielanfrage

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000

Beispielantwort

    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "daily_budget_amount_local_micro": 140000000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:53:54Z",
        "deleted": false
      }
    }

​

DELETE accounts/:account_id/campaigns/:campaign_id

Löscht die angegebene Kampagne, die zum aktuellen Account gehört.

Hinweis: Das Löschen einer Kampagne ist endgültig; spätere Versuche, die Ressource zu löschen, führen zu HTTP 404.

Resource URL

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

Parameters

Name	Beschreibung
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 Beispiel: 18ce54d4x5t
campaign_id erforderlich	Ein Verweis auf die Kampagne, auf die sich die Anfrage bezieht. Type: string Beispiel: 8yn7m

Example Request

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m

Example Response

    {
      "request": {
        "params": {
          "campaign_id": "8yn7m",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [],
        "servable": null,
        "purchase_order_number": null,
        "effective_status": "RUNNING",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8yn7m",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:56:35Z",
        "deleted": true
      }
    }

​

Inhaltskategorien

In Postman öffnen

​

GET content_categories

Fordern Sie die gültigen Inhalts-categories an, die als targeting_criteria für ein Line Item festgelegt werden sollen.

Jede content_category wird einer oder mehreren IAB-Kategorien zugeordnet. Dies kann erfolgen, indem der targeting_type am Batch-targeting_critera-endpoint auf IAB_CATEGORY gesetzt wird, sodass die Menge der entsprechenden iab_categories eingeschlossen wird, die durch die content_categories-Anfrage zurückgegeben werden. Andernfalls kommt es zu einem Validierungsfehler.

Publisher-Details zu jeder dieser Inhaltskategorien können über den endpoint GET publishers abgerufen werden.

Weitere Details finden Sie im Leitfaden zum Ziel „Video Views Pre-roll“.

Resource URL

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

Parameters

Keine Anfrageparameter

Example Request

GET https://ads-api.x.com/12/content_categories

Example Response

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Automobil (Autos, Lkw, Motorsport)",
          "id": "ru",
          "iab_categories": [
            "IAB2"
          ],
          "publishers_in_last_thirty_days": 12,
          "videos_monetized_in_last_thirty_days": 316
        },
        {
          "name": "Comedy",
          "id": "sk",
          "iab_categories": [
            "IAB1-4"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 174
        },
        {
          "name": "Digitale Creators",
          "id": "sl",
          "iab_categories": [
            "IAB25-1"
          ],
          "publishers_in_last_thirty_days": 110,
          "videos_monetized_in_last_thirty_days": 1257
        },
        {
          "name": "Entertainment & Popkultur",
          "id": "sm",
          "iab_categories": [
            "IAB1-1",
            "IAB1-2",
            "IAB1-3",
            "IAB1-5"
          ],
          "publishers_in_last_thirty_days": 120,
          "videos_monetized_in_last_thirty_days": 3482
        },
        {
          "name": "Finanz- und Wirtschaftsnachrichten",
          "id": "sn",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ],
          "publishers_in_last_thirty_days": 29,
          "videos_monetized_in_last_thirty_days": 1461
        },
        {
          "name": "Essen & Trinken",
          "id": "so",
          "iab_categories": [
            "IAB8-8",
            "IAB8-12",
            "IAB8-17",
            "IAB8-2",
            "IAB8-3",
            "IAB8-7",
            "IAB8-11",
            "IAB8-4",
            "IAB8-14",
            "IAB8-10",
            "IAB8-15",
            "IAB8-13",
            "IAB8-9",
            "IAB8-16",
            "IAB8-6",
            "IAB8-1"
          ],
          "publishers_in_last_thirty_days": 24,
          "videos_monetized_in_last_thirty_days": 516
        },
        {
          "name": "Lifestyle (Mode, Reisen, Wellness)",
          "id": "sp",
          "iab_categories": [
            "IAB16",
            "IAB9-21",
            "IAB9-4",
            "IAB9-25",
            "IAB9-8",
            "IAB4",
            "IAB9-3",
            "IAB9-15",
            "IAB7",
            "IAB6",
            "IAB9-11",
            "IAB9-16",
            "IAB9-7",
            "IAB9-20",
            "IAB9-24",
            "IAB9-17",
            "IAB9-12",
            "IAB9-31",
            "IAB9-27",
            "IAB10",
            "IAB9-10",
            "IAB9-23",
            "IAB9-6",
            "IAB9-18",
            "IAB9-13",
            "IAB9-1",
            "IAB9-28",
            "IAB20",
            "IAB9-5",
            "IAB9-26",
            "IAB22",
            "IAB23",
            "IAB9-9",
            "IAB9-22",
            "IAB18",
            "IAB9-2",
            "IAB9-19",
            "IAB9-14",
            "IAB9-29"
          ],
          "publishers_in_last_thirty_days": 67,
          "videos_monetized_in_last_thirty_days": 2412
        },
        {
          "name": "Musik",
          "id": "sq",
          "iab_categories": [
            "IAB1-6"
          ],
          "publishers_in_last_thirty_days": 31,
          "videos_monetized_in_last_thirty_days": 518
        },
        {
          "name": "Nachrichten & Aktuelles",
          "id": "sr",
          "iab_categories": [
            "IAB12",
            "IAB14"
          ],
          "publishers_in_last_thirty_days": 125,
          "videos_monetized_in_last_thirty_days": 5507
        },
        {
          "name": "Politik",
          "id": "s4",
          "iab_categories": [
            "IAB11"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 1402
        },
        {
          "name": "Wissenschaft & Bildung",
          "id": "ss",
          "iab_categories": [
            "IAB5",
            "IAB15"
          ],
          "publishers_in_last_thirty_days": 7,
          "videos_monetized_in_last_thirty_days": 132
        },
        {
          "name": "Sport",
          "id": "se",
          "iab_categories": [
            "IAB17"
          ],
          "publishers_in_last_thirty_days": 403,
          "videos_monetized_in_last_thirty_days": 18281
        },
        {
          "name": "Technologie",
          "id": "sg",
          "iab_categories": [
            "IAB19"
          ],
          "publishers_in_last_thirty_days": 13,
          "videos_monetized_in_last_thirty_days": 1089
        },
        {
          "name": "Fernsehen",
          "id": "sh",
          "iab_categories": [
            "IAB1-7"
          ],
          "publishers_in_last_thirty_days": 58,
          "videos_monetized_in_last_thirty_days": 1307
        },
        {
          "name": "Esports & Videospiele"
          "id": "s0",
          "iab_categories": [
            "IAB9-30"
          ],
          "publishers_in_last_thirty_days": 109,
          "videos_monetized_in_last_thirty_days": 1844
        }
      ],
      "total_count": 15
    }

​

Kuratierte Kategorien

In Postman öffnen

​

GET accounts/:account_id/curated_categories

Ruft eine Liste verfügbarer Curated Categories für die angegebenen country_codes ab.

Jede curated_category ist nur in bestimmten Ländern verfügbar, die über die country_codes in der Antwort angegeben werden.

Weitere Details finden Sie im Video Views Pre-roll Objective Guide.

Resource URL

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

Parameters

Name	Description
account_id required	Der Bezeichner für das verwendete Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen, mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
country_codes required	Beschränken Sie die Antwort auf die gewünschten Länder, indem Sie eine kommagetrennte Liste zweistelliger ISO-Ländercodes angeben. Es können bis zu 200 IDs übergeben werden. Typ: string Beispiel: US
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Typ: string Beispiel: 8x7v00oow

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US

Example Response

{
      "request": {
        "params": {
          "country_codes": [
            "US"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Basketball",
          "description": "Schalten Sie neben den besten täglichen Basketball-Inhalten, einschließlich College- und Profiteams sowie führenden Sportmedien-Accounts, die während der Saison und in der Offseason Basketballvideos teilen.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20265254",
            "378174762",
            "900368808",
            "18939563",
            "18371803",
            "18360370",
            "770658432928079872",
            "11026952",
            "37085464",
            "16212685",
            "57422635",
            "281669945",
            "7117962",
            "23065057",
            "41688179",
            "29779226",
            "900280416",
            "364460082",
            "902030382",
            "19409270",
            "19077044",
            "18139461",
            "14992591",
            "66753565",
            "667563",
            "16727749",
            "40941404",
            "18481113",
            "791598918",
            "16201775",
            "15900167",
            "45891626",
            "191894553",
            "2181233851",
            "34352904",
            "171483987",
            "454122399",
            "57415242",
            "19263978",
            "902089998",
            "423540866",
            "2715223320",
            "22185437",
            "17292143",
            "55590247",
            "66757066",
            "22642626",
            "41604618",
            "87275465",
            "22643259",
            "32414973",
            "73406718",
            "20346956",
            "413422891",
            "45412765",
            "19537303",
            "459511725",
            "30954864",
            "21308488",
            "18552281",
            "19924520",
            "24903350",
            "851142163",
            "26270913",
            "20444254",
            "26074296",
            "6395222",
            "15537451",
            "28672101",
            "38053254",
            "24925573",
            "19564719",
            "18164425",
            "22815383",
            "20196159"
          ],
          "id": "929wbl6ymlfk",
          "created_at": "2019-11-08T21:12:47Z",
          "updated_at": "2021-03-09T20:36:44Z",
          "videos_monetized_in_last_thirty_days": 2446
        },
        {
          "name": "Gaming-Persönlichkeiten",
          "description": "Schalten Sie neben den besten täglichen Gaming-Inhalten, exklusiv aus einer Liste einiger der größten und beliebtesten digitalen Creator im Online-Gaming.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "90779436",
            "268270621",
            "567167802",
            "246596682",
            "474919140",
            "284422688",
            "185909682",
            "4767225325",
            "2559865245",
            "186888760",
            "161418822",
            "141021153",
            "352881953",
            "1117931702",
            "146556805",
            "357294577",
            "234526497",
            "266687361",
            "214201922",
            "9451052",
            "2163885564",
            "2231422037",
            "116952434",
            "399909209",
            "15993650",
            "974356091193741312",
            "210839744",
            "2313002094",
            "159916388",
            "3258981481",
            "231992478",
            "182236262",
            "386884916",
            "22705686",
            "4140881832",
            "995979576",
            "2244953047",
            "311775629",
            "98821255",
            "2733210014",
            "2741078150"
          ],
          "id": "94ngssfrr01x",
          "created_at": "2019-12-02T20:45:12Z",
          "updated_at": "2021-03-09T20:18:13Z",
          "videos_monetized_in_last_thirty_days": 448
        },
        {
          "name": "Baseball",
          "description": "Schalten Sie neben den besten täglichen Baseball-Inhalten, einschließlich College- und Profiteams sowie führenden Sportmedien-Accounts, die umfassende Baseballberichterstattung teilen.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "22016177",
            "22798877",
            "52803520",
            "20710218",
            "423532170",
            "28603812",
            "41144996",
            "22819823",
            "39389304",
            "252273678",
            "123307490",
            "2319354187",
            "41488578",
            "37947138",
            "302066953",
            "159143990",
            "35006336",
            "53178109",
            "40918816",
            "39682297",
            "39397148",
            "39419180",
            "53197137",
            "52863923",
            "21407926",
            "31164229",
            "19607400",
            "39392910",
            "241544156",
            "43024351",
            "37837907",
            "165764237",
            "69117905",
            "87673496",
            "23043294",
            "52824038",
            "52861612",
            "33137450",
            "30008146",
            "39367703",
            "21436663",
            "188575356",
            "40931019",
            "41468683",
            "40927173",
            "172742915"
          ],
          "id": "9lav5usxfmdc",
          "created_at": "2020-05-18T20:20:27Z",
          "updated_at": "2021-03-09T20:37:46Z",
          "videos_monetized_in_last_thirty_days": 190
        },
        {
          "name": "Esports-Teams",
          "description": "Schalten Sie neben Programminhalten der weltweit führenden Esports-Teams, mit Live-Event-Berichterstattung sowie weiterer ganzjährig ergänzender Programmierung.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "759527448757215232",
            "61933836",
            "477213534",
            "907193396049182720",
            "895382891408089089",
            "862708050116976640",
            "115038550",
            "3182089458",
            "4131266472",
            "1145702070961496065",
            "2262070855",
            "920664872786059264",
            "1035653581683220481",
            "14229141",
            "1101275970995027968",
            "20734751",
            "1452520626",
            "720303639277928448",
            "2853641871",
            "912696400571486208",
            "874362688939413504",
            "286505380",
            "892808605170245632",
            "875087838613733376",
            "238431491",
            "867053221940011014",
            "964529942",
            "1172506293174710272",
            "535756639",
            "2255226817",
            "1100825469853696000",
            "1122713320086220803",
            "1124064709295128581",
            "899858978418642944",
            "864977592532688896",
            "864476897106898944",
            "862770685445361665",
            "257268592"
          ],
          "id": "9ys3jz3ktreo",
          "created_at": "2020-10-01T20:02:35Z",
          "updated_at": "2021-03-09T20:36:20Z",
          "videos_monetized_in_last_thirty_days": 169
        },
        {
          "name": "Football ",
          "description": "Schalten Sie neben den besten täglichen Football-Inhalten, einschließlich College- und Profiteams sowie führenden Sportmedien-Accounts, die während der Saison und in der Offseason Footballvideos teilen.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21790466",
            "53103297",
            "23642374",
            "817416193854283776",
            "43403778",
            "24179879",
            "26813914",
            "36375662",
            "33587536",
            "180884045",
            "16332223",
            "27902825",
            "180503626",
            "44468807",
            "18336787",
            "818431566",
            "22146282",
            "31126587",
            "40358743",
            "35865630",
            "16347506",
            "72665816",
            "33583496",
            "389038362",
            "36155311",
            "227342532",
            "2151130166",
            "26791995",
            "44666348",
            "24109979",
            "31504542",
            "713143",
            "423536031",
            "25545388",
            "59471027",
            "706923475",
            "19383279",
            "8824902",
            "1655877529",
            "18734310",
            "240734425",
            "17076218",
            "47964412",
            "2802184770",
            "19426729",
            "56443153",
            "23508439",
            "25084916",
            "764347046",
            "19853312",
            "348590880"
          ],
          "id": "8tujg1lvi8sn",
          "created_at": "2019-08-15T20:48:51Z",
          "updated_at": "2021-03-09T20:34:13Z",
          "videos_monetized_in_last_thirty_days": 254
        },
        {
          "name": "Men’s Culture + Lifestyle",
          "description": "Schalten Sie neben Inhalten von ausgewählten Handles, die anhand der Follower-Profile kuratiert wurden, um eine überwiegend männliche Zielgruppe zu erreichen – einschließlich einiger führender Handles, die Inhalte zu Technologie, Nachrichten und Lifestyle teilen.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "17764377",
            "61933836",
            "28370738",
            "3224616765",
            "22819823",
            "18927441",
            "734826612684783616",
            "14372486",
            "7157132",
            "15764136",
            "590316679",
            "7302282",
            "895014043932540928",
            "7517222",
            "3489420013",
            "14063426",
            "72665816",
            "214201922",
            "14980903",
            "22199141",
            "21272440",
            "25319414",
            "119593082",
            "4760694445",
            "765905855195803648",
            "238431491",
            "22178780",
            "241544156",
            "25093616",
            "16877611",
            "22146985",
            "368703433",
            "14342661",
            "415605847",
            "2181233851",
            "890891",
            "15764001",
            "614754689",
            "18479513",
            "23508439",
            "348590880"
          ],
          "id": "8tujj1ep7t34",
          "created_at": "2019-08-15T20:49:47Z",
          "updated_at": "2021-03-09T20:39:00Z",
          "videos_monetized_in_last_thirty_days": 1330
        },
        {
          "name": "Women’s Culture + Lifestyle",
          "description": "Schalten Sie neben Inhalten von ausgewählten Handles, die anhand der Follower-Profile kuratiert wurden, um eine überwiegend weibliche Zielgruppe zu erreichen – einschließlich einiger führender Handles, die Inhalte zu Popkultur, Nachrichten und Lifestyle teilen.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "23482952",
            "20177423",
            "19074134",
            "15566901",
            "32469566",
            "19784831",
            "16145224",
            "16932962",
            "14934818",
            "29730065",
            "24190981",
            "30278532",
            "15846407",
            "24994219",
            "23993734",
            "40965341",
            "16312576",
            "75094638",
            "549673665",
            "18806753",
            "75306892",
            "1482663290",
            "31181674",
            "971407531972186112",
            "4020532937",
            "25087685",
            "22515362",
            "80943051",
            "19247844",
            "15279429",
            "16824090",
            "20710809",
            "979831113655996416",
            "32432308",
            "19472585",
            "25589776",
            "739963476370673665",
            "20188834",
            "926269727663673349"
          ],
          "id": "8tujl1p3yn0g",
          "created_at": "2019-08-15T20:50:24Z",
          "updated_at": "2021-03-09T20:17:53Z",
          "videos_monetized_in_last_thirty_days": 1365
        },
        {
          "name": "Light-Hearted",
          "description": "Schalten Sie neben einer Liste von Handles, die aufgrund der Menge an positivem Feel‑Good‑Content und der beständig von ihnen auf X erzeugten Gespräche kuratiert wurden.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20177423",
            "22449367",
            "9695312",
            "19074134",
            "4805771380",
            "32469566",
            "1212860112047460352",
            "16402507",
            "16932962",
            "14934818",
            "17446621",
            "29730065",
            "15846407",
            "1604444052",
            "180066380",
            "16312576",
            "549673665",
            "18806753",
            "16211434",
            "545336345",
            "971407531972186112",
            "4020532937",
            "833612154",
            "22515362",
            "20710809",
            "32432308",
            "774311630",
            "3073349892",
            "926269727663673349"
          ],
          "id": "9fg8gmz96qdg",
          "created_at": "2020-03-20T19:37:44Z",
          "updated_at": "2021-03-09T19:57:40Z",
          "videos_monetized_in_last_thirty_days": 1395
        },
        {
          "name": "Soccer",
          "description": "Schalten Sie neben den besten täglichen Inhalten zum Thema Soccer, einschließlich College-Teams, Profi-Teams und führenden Sportmedien-Handles mit umfassender Soccer-Berichterstattung.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21677316",
            "20636347",
            "4704552148",
            "14573900",
            "22556296",
            "1415791555",
            "107146095",
            "17288520",
            "213474069",
            "17493398",
            "44990136",
            "452155423",
            "17744542",
            "16303450",
            "2841146601",
            "2413176055",
            "29739264",
            "38580532",
            "953476292913106945",
            "27092557",
            "86356439",
            "34613288",
            "3170659367",
            "119593082",
            "73412535",
            "627586654",
            "15891449",
            "23011345",
            "96951800",
            "15997022",
            "16960789",
            "21919642",
            "102965285",
            "17224076",
            "36432200",
            "1410055968"
          ],
          "id": "9ddrgesiap6o",
          "created_at": "2020-02-28T22:43:26Z",
          "updated_at": "2021-01-26T17:54:55Z",
          "videos_monetized_in_last_thirty_days": 421
        }
      ],
      "total_count": 9
    }

​

GET accounts/:account_id/curated_categories/:curated_category_id

Rufen Sie Details für eine bestimmte curated_category_id ab

Jede curated_category ist nur in bestimmten Ländern verfügbar, die über die country_codes in der Antwort angegeben sind.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
curated_category_id erforderlich	Ein Verweis auf die Curated Category, mit der Sie in der Anfrage arbeiten. Type: string Example: 9ddrgesiap6o

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o

Example Response

    {
      "request": {
        "params": {
          "id": "9ddrgesiap6o",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "Soccer",
        "description": "Schalten Sie Anzeigen neben den besten täglichen Soccer-Inhalten, einschließlich College-Teams, Profiteams und führenden Sportmedien-Accounts, die umfassende Soccer-Berichterstattung teilen.",
        "country_codes": [],
        "publisher_user_ids": [
          "21677316",
          "20636347",
          "4704552148",
          "14573900",
          "22556296",
          "1415791555",
          "107146095",
          "17288520",
          "213474069",
          "17493398",
          "44990136",
          "452155423",
          "17744542",
          "16303450",
          "2841146601",
          "2413176055",
          "29739264",
          "38580532",
          "953476292913106945",
          "27092557",
          "86356439",
          "34613288",
          "3170659367",
          "119593082",
          "73412535",
          "627586654",
          "15891449",
          "23011345",
          "96951800",
          "15997022",
          "16960789",
          "21919642",
          "102965285",
          "17224076",
          "36432200",
          "1410055968"
        ],
        "id": "9ddrgesiap6o",
        "created_at": "2020-02-28T22:43:26Z",
        "updated_at": "2021-01-26T17:54:55Z",
        "videos_monetized_in_last_thirty_days": 421
      }
    }

​

Funktionen

In Postman öffnen

​

GET accounts/:account_id/features

Ruft die Menge der diesem Ads-Konto gewährten Features ab. Features werden durch einen beschreibenden Feature-Schlüssel gekennzeichnet und sind nur an diesem endpoint sichtbar, wenn sie in einer Beta- oder anderweitig begrenzten Veröffentlichung eingeführt wurden und in der Ads API verfügbar sind. Features, die diese Kriterien nicht erfüllen, werden an diesem endpoint nicht ausgegeben.

Hinweis: Dieser endpoint unterstützt die Entwicklung im Ads API-Ökosystem, indem er die Sichtbarkeit des Clientzugriffs auf Beta-Veröffentlichungen verbessert. API-Entwickler können keinen Zugriff auf Features im Namen eines Werbetreibenden beantragen. Diese Anfragen können nur vom Werbetreibenden an seinen X Account Manager gestellt werden.

Resource URL

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

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 Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
feature_keys optional	Ein optionaler Parameter, der die Abfrage eines bestimmten Feature-Schlüssels ermöglicht. Anfragen können mehrere, durch Komma getrennte Schlüssel enthalten. Hinweis: In die Antwort werden nur die Features aufgenommen, auf die dieses Konto Zugriff hat. Type: enum Possible values: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING

Example Request

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

Example Response

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": [
        "CITY_TARGETING",
        "CONVERSATION_CARD",
        "PROMOTED_MEDIA_POLLS",
        "REACH_AND_FREQUENCY_ANALYTICS",
        "REACH_FREQUENCY_CAP",
        "UNIVERSAL_LOOKALIKE"
      ]
    }

​

POST accounts/:account_id/features

NUR SANDBOX

Fügen Sie einem Sandbox-Konto ein Feature hinzu.

Die aktuelle Liste der Konto-Features kann über den Endpoint GET accounts/:account_id/features abgerufen werden.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen, mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: gq180y
feature_keys erforderlich	Eine kommagetrennte Liste von Konto-Features, die dem Konto hinzugefügt werden sollen. Typ: enum Mögliche Werte: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD

Beispielanfrage

POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "VALIDATED_AGE_TARGETING"
          ]
        }
      },
      "data": [
        "ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE",
        "AWARENESS_OBJECTIVE",
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VALIDATED_AGE_TARGETING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

​

DELETE accounts/:account_id/features

NUR SANDBOX

Entfernt ein Feature aus einem Sandbox-Konto.

Die aktuelle Liste der Konto-Features kann über den endpoint GET accounts/:account_id/features abgerufen werden.

Resource-URL

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

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 Beispiel: gq180y
feature_keys erforderlich	Eine kommagetrennte Liste von Konto-Features, die aus dem Konto entfernt werden sollen. Type: enum Mögliche Werte: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD

Beispielanfrage

DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "PREROLL_VIEWS_OBJECTIVE"
          ]
        }
      },
      "data": [
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

​

Finanzierungsinstrumente

In Postman öffnen

​

GET accounts/:account_id/funding_instruments

Rufen Sie Details zu einigen oder allen dem aktuellen Konto zugeordneten Zahlungsinstrumenten ab.

Resource-URL

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

Parameter

Name	Beschreibung
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
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
funding_instrument_ids optional	Beschränken Sie die Antwort auf die gewünschten Zahlungsinstrumente, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: lygyi
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließt das Antwortattribut total_count ein. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Beispielanfrage

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

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "start_time": "2016-07-22T04:24:04Z",
          "description": "Visa mit Endziffer 0650",
          "credit_limit_local_micro": 200000000,
          "end_time": null,
          "id": "lygyi",
          "entity_status": "ACTIVE",
          "account_id": "18ce54d4x5t",
          "reasons_not_able_to_fund": [],
          "io_header": null,
          "currency": "USD",
          "funded_amount_local_micro": 645940000,
          "created_at": "2016-07-22T04:24:04Z",
          "type": "CREDIT_CARD",
          "able_to_fund": true,
          "updated_at": "2017-04-05T00:25:13Z",
          "credit_remaining_local_micro": null,
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/funding_instruments/:funding_instrument_id

Rufen Sie ein bestimmtes Finanzierungsinstrument ab, das dem aktuellen Account zugeordnet ist.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner für den genutzten Account. 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. Der angegebene Account muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
funding_instrument_id erforderlich	Eine Referenz auf das Finanzierungsinstrument, mit dem Sie in der Anfrage arbeiten. Type: string Example: lygyi
with_deleted optional	Beziehen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi

Example Response

    {
      "request": {
        "params": {
          "funding_instrument_id": "lygyi",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "start_time": "2016-07-22T04:24:04Z",
        "description": "Visa endend in 0650",
        "credit_limit_local_micro": 200000000,
        "end_time": null,
        "id": "lygyi",
        "entity_status": "ACTIVE",
        "account_id": "18ce54d4x5t",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 645940000,
        "created_at": "2016-07-22T04:24:04Z",
        "type": "CREDIT_CARD",
        "able_to_fund": true,
        "updated_at": "2017-04-05T00:25:13Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      }
    }

​

POST accounts/:account_id/funding_instruments

NUR SANDBOX

Erstellen Sie ein Finanzierungsinstrument in der Sandbox-Umgebung.

Bei der Verwendung eines Sandbox-Finanzierungsinstruments besteht kein Kostenrisiko.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das betreffende 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. Typ: string Beispiel: gq1844
currency erforderlich	Die Währung, angegeben gemäß ISO-4217. Typ: string Beispiel: USD
start_time erforderlich	Das Datum, ab dem das Finanzierungsinstrument aktiv und nutzbar ist, angegeben gemäß ISO 8601. Typ: string Beispiel: 2017-05-19T07:00:00Z
type erforderlich	Der Typ des zu erstellenden Finanzierungsinstruments. Typ: enum Mögliche Werte: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED
end_time unter Umständen erforderlich	Das Datum, ab dem das Finanzierungsinstrument inaktiv ist, angegeben gemäß ISO 8601. Typ: string Beispiel: 2017-05-26T07:00:00Z
credit_limit_local_micro optional	Der insgesamt verfügbare Kredit für dieses Finanzierungsinstrument. Hinweis: Nur für einige Typen von Finanzierungsinstrumenten anwendbar. Typ: long Beispiel: 37500000
funded_amount_local_micro optional	Der dem Finanzierungsinstrument zugewiesene Gesamtbetrag des Budgets. Hinweis: Nur für einige Typen von Finanzierungsinstrumenten anwendbar. Typ: long Beispiel: 37500000

Example Request

POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000

Example Response

    {
      "data": {
        "start_time": "2017-07-10T00:00:00Z",
        "description": "(noch keine Zahlungsmethode eingerichtet)",
        "credit_limit_local_micro": null,
        "end_time": "2018-01-10T00:00:00Z",
        "id": "hxtet",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 140000000000,
        "created_at": "2017-09-09T05:23:28Z",
        "type": "INSERTION_ORDER",
        "able_to_fund": true,
        "updated_at": "2017-09-09T05:23:28Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      },
      "request": {
        "params": {
          "start_time": "2017-07-10T00:00:00Z",
          "end_time": "2018-01-10T00:00:00Z",
          "account_id": "gq1844",
          "currency": "USD",
          "funded_amount_local_micro": 140000000000,
          "type": "INSERTION_ORDER"
        }
      }
    }

​

DELETE accounts/:account_id/funding_instruments/:funding_instrument_id

NUR SANDBOX

Löscht ein Finanzierungsinstrument in der Sandbox-Umgebung.

Ressourcen-URL

https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte 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 Benutzer zugeordnet sein. Type: string Beispiel: gq1844
funding_instrument_id erforderlich	Ein Verweis auf das Finanzierungsinstrument, das in der Anfrage verwendet wird. Type: string Beispiel: hxt82

Beispielanfrage

DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82

Beispielantwort

    {
      "data": {
        "start_time": "2017-08-30T19:23:47Z",
        "description": "(noch keine Zahlungsmethode eingerichtet)",
        "credit_limit_local_micro": 500000000,
        "end_time": null,
        "id": "hxt82",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [
          "DELETED"
        ],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": null,
        "created_at": "2017-08-30T19:23:47Z",
        "type": "CREDIT_CARD",
        "able_to_fund": false,
        "updated_at": "2017-09-09T02:08:30Z",
        "credit_remaining_local_micro": null,
        "deleted": true
      },
      "request": {
        "params": {
          "funding_instrument_id": "hxt82",
          "account_id": "gq1844"
        }
      }
    }

​

IAB-Kategorien

In Postman öffnen

​

GET iab_categories

Fordern Sie die gültigen App-categories für Anzeigengruppen (line_items) an.

Ressourcen-URL

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

Parameter

Name	Beschreibung
count optional	Legt fest, wie viele Datensätze 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 Kategorien abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: gc-ddf4a
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

Beispielanfrage

GET https://ads-api.x.com/12/iab_categories?count=2

Beispielantwort

    {
      "data": [
        {
          "id": "IAB1",
          "parent_id": null,
          "name": "Kunst & Unterhaltung"
        },
        {
          "id": "IAB1-1",
          "parent_id": "IAB1",
          "name": "Bücher & Literatur"
        }
      ],
      "next_cursor": "uxa8",
      "request": {
        "params": {
          "count": 2
        }
      }
    }

​

Positionen

In Postman öffnen

​

GET accounts/:account_id/line_items

Rufen Sie Details für einige oder alle dem aktuellen Konto zugeordneten Line Items ab.

Resource-URL

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

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. Typ: string Beispiel: 18ce54d4x5t
campaign_ids optional	Beschränken Sie die Antwort auf die Line Items bestimmter Kampagnen, indem Sie eine durch Komma getrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Typ: string Beispiel: 8gdx6
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
funding_instrument_ids optional	Beschränken Sie die Antwort auf die Line Items bestimmter Funding Instruments, indem Sie eine durch Komma getrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Typ: string Beispiel: lygyi
line_item_ids optional	Beschränken Sie die Antwort auf die gewünschten Line Items, indem Sie eine durch Komma getrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Typ: string Beispiel: 8v7jo
q optional	Eine optionale Abfrage, um die Ressource nach name einzuschränken. 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
with_deleted optional	Schließen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Typ: boolean Standard: false Mögliche Werte: true, false
with_draft optional	Schließen Sie Ergebnisse von Entwurfskampagnen in Ihre Anfrage ein. Typ: boolean Standard: false Mögliche Werte: true, false
with_total_count optional	Schließen Sie das Antwortattribut total_count ein. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Typ: boolean Standard: false Mögliche Werte: true, false

Beispielanfrage

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "itttx"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": "li-18",
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2021-02-16T00:00:00Z",
          "bid_amount_local_micro": 320000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "itttx",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2021-02-23T23:37:54Z",
          "ios_app_store_identifier": null,
          "updated_at": "2022-06-01T02:01:18Z",
          "campaign_id": "f4z6x",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/line_items/:line_item_id

Rufen Sie ein bestimmtes Line Item ab, das dem aktuellen Konto zugeordnet ist.

Resource URL

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

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 Beispiel: 18ce54d4x5t
line_item_id erforderlich	Ein Verweis auf das Line Item, mit dem die Anfrage arbeitet. Type: string Beispiel: 8v7jo
with_deleted optional	Gelöschte Ergebnisse in die Anfrage einschließen. Type: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx

Example Response

    {
      "request": {
        "params": {
          "line_item_id": "itttx",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": "li-18",
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2021-02-16T00:00:00Z",
        "bid_amount_local_micro": 320000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "funding_instrument_id": "lygyi",
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "itttx",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2021-02-23T23:37:54Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-01T02:01:18Z",
        "campaign_id": "f4z6x",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​

POST accounts/:account_id/line_items

Erstellt ein Line Item, das mit der angegebenen Kampagne verknüpft ist und zum aktuellen Konto gehört.

Alle Line Items innerhalb einer Kampagne müssen denselben product_type und dasselbe objective aufweisen.

Bei Verwendung des Produkttyps PROMOTED_ACCOUNT führt das Verknüpfen eines Tweets mit dem line_item zusätzlich zur standardmäßigen PROMOTED_ACCOUNT-Platzierung zu Timeline-Platzierungen auf Mobilgeräten.

Das Setzen von android_app_store_identifier oder ios_app_store_identifier fügt automatisch die Targeting-Kriterien für das Line Item hinzu, die der beworbenen mobilen App entsprechen; beispielsweise würde das Übergeben von ios_app_store_identifier PLATFORM-Targeting-Kriterien für iOS hinzufügen.

Hinweis: Es gibt ein Limit von 100 Line Items pro Kampagne und 256 aktiven Line Items über alle Kampagnen hinweg.

Resource URL

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

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
campaign_id erforderlich	Der Bezeichner der Kampagne, unter der das Line Item erstellt wird. Typ: string Beispiel: 8slvg
end_time erforderlich	Der Zeitpunkt im Format ISO 8601, zu dem das Line Item nicht mehr ausgeliefert wird. Typ: string Beispiel: 2017-10-05T00:00:00Z
objective erforderlich	Das Kampagnenziel für dieses Line Item. Typ: enum Mögliche Werte: APP_ENGAGEMENTS, APP_INSTALLS, REACH, FOLLOWERS, ENGAGEMENTS, VIDEO_VIEWS, PREROLL_VIEWS, WEBSITE_CLICKS
placements erforderlich	Die Platzierung(en), in denen dieses Line Item angezeigt wird. Geben Sie eine kommagetrennte Liste von Platzierungswerten an. Typ: enum Mögliche Werte: ALL_ON_TWITTER, PUBLISHER_NETWORK, TAP_BANNER, TAP_FULL, TAP_FULL_LANDSCAPE, TAP_NATIVE, TAP_MRECT,TWITTER_PROFILE, TWITTER_REPLIES, TWITTER_SEARCH, TWITTER_TIMELINE
product_type erforderlich	Der Typ des beworbenen Produkts, den dieses Line Item enthält. Typ: enum Mögliche Werte: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
start_time erforderlich	Der Zeitpunkt im Format ISO 8601, zu dem das Line Item mit der Auslieferung beginnt. Typ: string Beispiel: 2017-07-05T00:00:00Z
advertiser_domain manchmal erforderlich	Die Website-Domain für diesen Werbetreibenden, ohne Protokollangabe. Hinweis: Erforderlich, wenn die Platzierung des Line Items auf PUBLISHER_NETWORK gesetzt ist. Typ: string Beispiel: x.com
android_app_store_identifier manchmal erforderlich	Der Google-App-Store-Bezeichner für beworbene Anwendungen. Hinweis: Die Ziele APP_INSTALLS und APP_ENGAGEMENTS erfordern die Angabe mindestens eines App-Store-Bezeichners — entweder android_app_store_identifier oder ios_app_store_identifier. Typ: string Beispiel: com.twitter.android
bid_amount_local_micro manchmal erforderlich	Der mit diesem Line Item verknüpfte Gebotsbetrag. Es wird die Währung des angegebenen Finanzierungsinstruments verwendet. Für USD wird 5,50 $ als 5500000 dargestellt. Hinweis: Erforderlich, wenn bid_strategy auf MAX oder TARGET gesetzt ist. Hinweis: Es werden nur Werte größer als null akzeptiert. Typ: long Beispiel: 5500000
categories manchmal erforderlich	Die relevanten IAB-Kategorien für diesen Werbetreibenden. Siehe GET iab_categories. Hinweis: Erforderlich, wenn die Platzierung des Line Items auf PUBLISHER_NETWORK gesetzt ist. Typ: string Beispiel: IAB3-1
ios_app_store_identifier manchmal erforderlich	Der numerische Teil des Apple-App-Store-Bezeichners für beworbene Anwendungen. Hinweis: Die Ziele APP_INSTALLS und APP_ENGAGEMENTS erfordern die Angabe mindestens eines App-Store-Bezeichners — entweder android_app_store_identifier oder ios_app_store_identifier. Typ: string Beispiel: 333903271
primary_web_event_tag manchmal erforderlich	Der Bezeichner des primären Web-Event-Tags. Ermöglicht eine genauere Erfassung von Interaktionen für die Kampagne im Zusammenhang mit diesem Line Item. Hinweis: Erforderlich, wenn das Ziel des Line Items auf WEBSITE_CONVERSIONS gesetzt ist. Typ: string Beispiel: nvo4z
advertiser_user_id optional	Die X-Nutzerkennung für den Handle, der eine PREROLL_VIEWS-Anzeige bewirbt. Nur bestimmte Client-Anwendungen dürfen diesen Parameter verwenden. Typ: string Beispiel: 312226591
audience_expansion optional	Dient zur Erweiterung der Reichweite von Kampagnen, indem Nutzer angesprochen werden, die den bereits Zielgerichteten ähnlich sind. Hinweis: Standardmäßig wird keine Erweiterung angewendet. Typ: enum Mögliche Werte: BROAD, DEFINED, EXPANDED
bid_strategy optional	Der Gebotsmechanismus. AUTO optimiert Gebote automatisch basierend auf Tagesbudget und Kampagnenlaufzeit. MAX setzt das maximal zulässige Gebot und ist nicht verfügbar, wenn das Ziel auf REACH oder FOLLOWERS gesetzt ist. TARGET versucht, tägliche Gebotsdurchschnitte innerhalb von 20 % des angegebenen bid_amount_local_micro zu halten und ist verfügbar, wenn das Ziel auf REACH, FOLLOWERS oder WEBSITE_CLICKS gesetzt ist. Hinweis: Wenn auf AUTO gesetzt, wird bid_amount_local_micro ignoriert. Hinweis: Standard abhängig vom Ziel. Typ: enum Mögliche Werte: AUTO, MAX, TARGET
duration_in_days optional	Der Zeitraum, innerhalb dessen das frequency_cap erreicht wird. Typ: int Mögliche Werte: 1, 7, 30
entity_status optional	Der Status des Line Items. Typ: enum Standard: ACTIVE Mögliche Werte: ACTIVE, DRAFT, PAUSED
frequency_cap optional	Die maximale Anzahl, wie oft eine Anzeige einem Nutzer zugestellt werden kann. Hinweis: Unterstützt nur für die Ziele REACH, ENGAGEMENTS, VIDEO_VIEWS und PREROLL_VIEWS. Typ: int Beispiel: 5
goal optional	Die Optimierungseinstellung, die mit diesem Line Item verwendet wird. Die Option APP_PURCHASES ist für APP_INSTALL verfügbar. Die Optionen APP_CLICKS und APP_INSTALLS sind sowohl für die Ziele APP_INSTALL als auch APP_ENGAGEMENTS verfügbar und können die Nutzung eines unterstützten MACT-Partners erfordern. Die Option SITE_VISITS ist nur mit dem Ziel WEBSITE_CLICKS verfügbar. Hinweis: Standard abhängig vom Ziel. Typ: enum Mögliche Werte: APP_CLICKS, APP_INSTALLS, APP_PURCHASES,ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, SITE_VISITS, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
name optional	Der Name des Line Items. Typ: string Beispiel: demo Min., Max. Länge: 1, 255
pay_by optional	Die Einheit, nach der diese Anzeigenposition abgerechnet wird. Diese Einstellung kann nur für Anzeigenpositionen mit dem APP_INSTALLS-Ziel geändert werden. Hinweis: Der Standard-pay_by-Wert wird automatisch basierend auf dem Kampagnenziel und der Gebotseinheit der Anzeigenposition festgelegt. Das APP_INSTALLS-Ziel unterstützt sowohl APP_CLICK- als auch IMPRESSION-Werte. IMPRESSION ist der Standardwert. Das LINK_CLICKS-Ziel unterstützt sowohl LINK_CLICK- als auch IMPRESSION-Werte. IMPRESSION ist der Standardwert, wird jedoch nicht unterstützt, wenn TARGET für bid_strategy festgelegt ist. Das SITE_VISITS-Ziel unterstützt IMPRESSION-Werte. Typ: enum Mögliche Werte: APP_CLICK, IMPRESSION, LINK_CLICK
standard_delivery optional	Aktiviert Standard- oder beschleunigte Auslieferung. Siehe Budget Pacing für weitere Informationen zu Standard- versus beschleunigter Auslieferung. Nur verfügbar, wenn budget_optimization für die übergeordnete Kampagne auf LINE_ITEM gesetzt ist Typ: boolean Standard: true Mögliche Werte: true, false
total_budget_amount_local_micro optional	Der Gesamtbudgetbetrag, der der Anzeigenposition zugewiesen werden soll. Die mit dem angegebenen Finanzierungsinstrument verknüpfte Währung wird verwendet. Für USD werden 37,50 $ als 37500000 dargestellt. Typ: long Beispiel: 37500000
daily_budget_amount_local_micro sometimes required	Der tägliche Budgetbetrag, der der Kampagne zugewiesen werden soll. Die mit dem angegebenen Finanzierungsinstrument verknüpfte Währung wird verwendet. Für USD werden 5,50 $ als 5500000 dargestellt. Wenn nicht angegeben, wird die Kampagne gleichmäßig basierend auf dem Gesamtbudget und der Dauer der Kampagnenlaufzeit ausgegeben. Nur verfügbar, wenn budget_optimization für die übergeordnete Kampagne auf LINE_ITEM gesetzt ist Hinweis: Dieser Wert sollte kleiner oder gleich dem total_budget_amount_local_micro sein. Typ: long Beispiel: 5500000

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15

Beispielantwort

    {
      "request": {
        "params": {
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2022-06-15T00:00:00Z",
          "bid_amount_local_micro": 3210000,
          "daily_budget_amount_local_micro": 1000000,
          "product_type": "PROMOTED_TWEETS",
          "objective": "ENGAGEMENTS",
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t",
          "campaign_id": "hwtq0"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2022-06-15T00:00:00Z",
        "bid_amount_local_micro": 3210000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": 1000000,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": true,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "ml5vs",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2022-06-03T23:47:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:47:20Z",
        "campaign_id": "hwtq0",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​

POST batch/accounts/:account_id/line_items

Ermöglicht die Stapelerstellung neuer Line Items mit einer einzigen Anfrage.

Batch-Anfragen

• Die aktuelle maximale Batchgröße beträgt 40.
• Alle Parameter werden im Anfrage-Body gesendet; der Content-Type muss application/json sein.
• Batch-Anfragen schlagen gemeinsam fehl oder sind gemeinsam erfolgreich. Alle API-Antworten für Fehler und Erfolg erhalten die Reihenfolge der Elemente aus der ursprünglichen Anfrage.

Batch-Antworten

Batch-API-Antworten liefern eine geordnete Sammlung von Elementen. Ansonsten sind sie strukturell mit den entsprechenden Endpunkten für einzelne Elemente identisch.

Batch-Fehler

• Fehler auf Anfrageebene (z. B. maximale Batchgröße überschritten) werden in der Antwort im Objekt errors angezeigt.
• Fehler auf Elementebene (z. B. erforderlicher Line-Item-Parameter fehlt) werden in der Antwort im Objekt operation_errors angezeigt.

Resource-URL

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

Parameter

Name	Beschreibung
operation_type erforderlich	Der pro Element ausgeführte Operationstyp. Typ: enum Mögliche Werte: Create, Delete, Update
params erforderlich	Ein JSON-Objekt, das alle Parameter für die Line-Item-Objekte enthält. Eine Liste der erforderlichen und optionalen Line-Item-Parameter finden Sie hier.

Beispielanfrage

POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items

    [
      {
        "operation_type":"Create",
        "params":{
          "campaign_id":"8yn7m",
          "objective":"ENGAGEMENTS",
          "product_type":"PROMOTED_TWEETS",
          "placements":"ALL_ON_TWITTER",
          "bid_amount_local_micro":3210000,
          "entity_status":"PAUSED"
        }
      }
    ]

Beispielantwort

    {
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": null,
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": null,
          "bid_amount_local_micro": 3210000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "9cqi0",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2017-07-07T17:42:20Z",
          "ios_app_store_identifier": null,
          "updated_at": "2017-07-07T17:42:20Z",
          "campaign_id": "8yn7m",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "placements": [
              "ALL_ON_TWITTER"
            ],
            "bid_amount_local_micro": 3210000,
            "product_type": "PROMOTED_TWEETS",
            "objective": "ENGAGEMENTS",
            "entity_status": "PAUSED",
            "account_id": "18ce54d4x5t",
            "campaign_id": "8yn7m"
          },
          "operation_type": "Create"
        }
      ]
    }

​

PUT accounts/:account_id/line_items/:line_item_id

Aktualisiert das angegebene Line Item, das dem aktuellen Konto zugeordnet ist.

Ressourcen-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Die Kennung für das verwendete Konto. Erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser API-Anfragen, ausgenommen GET accounts. Das angegebene Konto muss mit dem authentifizierten Nutzer verknüpft sein. Typ: string Beispiel: 18ce54d4x5t
line_item_id erforderlich	Ein Verweis auf das Line Item, mit dem Sie in der Anfrage arbeiten. Typ: string Beispiel: 8v7jo
advertiser_domain optional	Die Website-Domain für diesen Werbetreibenden, ohne Protokollangabe. Hinweis: Erforderlich, wenn die Platzierung des Line Items auf PUBLISHER_NETWORK gesetzt ist. Typ: string Beispiel: x.com
advertiser_user_id optional	Die X-Nutzerkennung für den Handle, der eine PREROLL_VIEWS-Anzeige bewirbt. Nur bestimmte Client-Anwendungen dürfen diesen Parameter verwenden. Typ: string Beispiel: 312226591
android_app_store_identifier optional	Die Google App Store-Kennung für die beworbene Anwendung. Hinweis: APP_INSTALLS- und APP_ENGAGEMENTS-Ziele erfordern die Festlegung mindestens einer App Store-Kennung — entweder android_app_store_identifier oder ios_app_store_identifier. Typ: string Beispiel: com.twitter.android
audience_expansion optional	Wird verwendet, um die Reichweite von Kampagnen zu erweitern, indem Nutzer angesprochen werden, die denen ähnlich sind, die bereits angesprochen werden. Typ: enum Mögliche Werte: BROAD, DEFINED, EXPANDED
bid_amount_local_micro optional	Der Gebotsbetrag, der mit diesem Line Item verknüpft werden soll. Die Währung des angegebenen Finanzierungsinstruments wird verwendet. Für USD wird 5,50 $ als 5500000 dargestellt. Hinweis: Erforderlich, wenn bid_strategy auf MAX oder TARGET gesetzt ist Hinweis: Nur Werte größer als null werden akzeptiert. Typ: long Beispiel: 140000
bid_strategy optional	Der Gebotsmechanismus. AUTO optimiert automatisch die Gebote basierend auf dem Tagesbudget und den Kampagnenlaufzeiten. MAX legt das maximal zulässige Gebot fest und ist nicht verfügbar, wenn das Ziel auf REACH oder FOLLOWERS gesetzt ist. TARGET versucht, die täglichen Gebotsdurchschnitte innerhalb von 20 % des angegebenen bid_amount_local_micro zu halten und ist verfügbar, wenn das Ziel auf REACH oder WEBSITE_CLICKS gesetzt ist. Hinweis: Wenn auf AUTO gesetzt, wird bid_amount_local_micro ignoriert. Hinweis: Standard basiert auf dem Ziel. Typ: enum Mögliche Werte: AUTO, MAX, TARGET
categories optional	Die relevanten IAB-Kategorien für diesen Werbetreibenden. Siehe GET iab_categories. Hinweis: Erforderlich, wenn die Platzierung des Line Items auf PUBLISHER_NETWORK gesetzt ist. Typ: string Beispiel: IAB3-1
duration_in_days optional	Der Zeitraum, innerhalb dessen die frequency_cap erreicht wird. Typ: int Mögliche Werte: 1, 7, 30
entity_status optional	Der Status des Line Items. Typ: enum Mögliche Werte: ACTIVE, PAUSED
end_time optional	Die Zeit, ausgedrückt in ISO 8601, zu der das Line Item die Auslieferung beendet. Typ: string Beispiel: 2017-10-05T00:00:00Z
frequency_cap optional	Die maximale Anzahl von Malen, die eine Anzeige an einen Nutzer ausgeliefert werden kann. Hinweis: Nur unterstützt für REACH-, ENGAGEMENTS-, VIDEO_VIEWS- und PREROLL_VIEWS-Ziele. Typ: int Beispiel: 5
goal optional	Die Optimierungseinstellung, die mit diesem Line Item verwendet werden soll. Die Option APP_PURCHASES ist für APP_INSTALL verfügbar. Die Optionen APP_CLICKS und APP_INSTALLS sind für APP_INSTALL und APP_ENGAGEMENTS verfügbar und erfordern möglicherweise die Verwendung eines unterstützten MACT-Partners. Hinweis: Standard basiert auf dem Ziel. Typ: enum Mögliche Werte: APP_CLICKS, APP_INSTALLS, APP_PURCHASES, ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
ios_app_store_identifier optional	Der numerische Teil der Apple App Store-Kennung für beworbene Anwendungen. Hinweis: APP_INSTALLS- und APP_ENGAGEMENTS-Ziele erfordern die Festlegung mindestens einer App Store-Kennung — entweder android_app_store_identifier oder ios_app_store_identifier. Typ: string Beispiel: 333903271
name optional	Der Name für das Line Item. Typ: string Beispiel: demo
pay_by optional	Die Einheit, nach der dieses Line Item abgerechnet wird. Diese Einstellung kann nur für Line Items mit dem Ziel APP_INSTALLS geändert werden. Hinweis: Der Standard-pay_by wird automatisch basierend auf dem Kampagnenziel und der Gebotseinheit des Line Items festgelegt. Das Ziel APP_INSTALLS unterstützt sowohl APP_CLICK- als auch IMPRESSION-Werte. IMPRESSION ist der Standardwert. Das Ziel LINK_CLICKS unterstützt sowohl LINK_CLICK- als auch IMPRESSION-Werte. IMPRESSION ist der Standardwert, wird aber nicht unterstützt, wenn TARGET für bid_strategy gesetzt ist. Das Ziel SITE_VISITS unterstützt IMPRESSION-Werte. Typ: enum Mögliche Werte: APP_CLICK, IMPRESSION, LINK_CLICK
start_time optional	Die Zeit, ausgedrückt in ISO 8601, zu der das Line Item mit der Auslieferung beginnt. Typ: string Beispiel: 2017-07-05T00:00:00Z
total_budget_amount_local_micro optional	Der Gesamtbudgetbetrag, der dem Line Item zugewiesen werden soll. Die Währung des angegebenen Finanzierungsinstruments wird verwendet. Für USD wird 37,50 $ als 37500000 dargestellt. Typ: long Beispiel: 37500000
daily_budget_amount_local_micro optional	Der Tagesbudgetbetrag, der der Kampagne zugewiesen werden soll. Die Währung des angegebenen Finanzierungsinstruments wird verwendet. Für USD wird 5,50 $ als 5500000 dargestellt. Wenn nicht angegeben, wird die Kampagne gleichmäßig basierend auf dem Gesamtbudget und der Dauer der Kampagnenlaufzeit ausgeben. Nur verfügbar, wenn budget_optimization für die übergeordnete Kampagne auf LINE_ITEM gesetzt ist Hinweis: Dies sollte kleiner oder gleich dem total_budget_amount_local_micro sein. Typ: long Beispiel: 5500000

Beispielanfrage

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000

Beispielantwort

    {
      "request": {
        "params": {
          "line_item_id": "9cqi0",
          "bid_amount_local_micro": 140000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2017-07-10T00:00:00Z",
        "bid_amount_local_micro": 140000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9cqi0",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2017-07-07T17:42:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:51:36Z",
        "campaign_id": "8yn7m",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​

DELETE accounts/:account_id/line_items/:line_item_id

Löscht das angegebene Line Item, das zum aktuellen Account gehört.

Hinweis: Das Löschen eines Line Items ist nicht reversibel; nachfolgende Versuche, die Ressource zu löschen, liefern HTTP 404.

Hinweis: Wenn ein Line Item gelöscht wird, werden seine untergeordneten promoted_tweets in den Endpoints GET accounts/:account_id/promoted_tweets und GET accounts/:account_id/promoted_tweets/:promoted_tweet_id nur zurückgegeben, wenn with_deleted=true in der Anfrage angegeben ist. Diese promoted_tweets werden jedoch nicht tatsächlich gelöscht ("deleted": false in der Antwort). Wir führen keine Kaskadenlöschungen durch.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner für den genutzten Account. Erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API‑Anfragen, ausgenommen GET accounts. Der angegebene Account muss dem authentifizierten Benutzer zugeordnet sein. Type: string Beispiel: 18ce54d4x5t
line_item_id erforderlich	Ein Verweis auf das Line Item, mit dem die Anfrage operiert. Type: string Beispiel: 9f2ix

Example Request

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix

Example Response

    {
      "data": {
        "bid_strategy": "MAX",
        "advertiser_user_id": "756201191646691328",
        "name": "Ohne Titel",
        "placements": [],
        "start_time": null,
        "bid_amount_local_micro": 100000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "pay_by": "ENGAGEMENT",
        "product_type": "PROMOTED_TWEETS",
        "end_time": "2017-07-21T00:00:00Z",
        "duration_in_days": 1,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9f2ix",
        "entity_status": "ACTIVE",
        "goal": "ENGAGEMENT",
        "frequency_cap": 5,
        "categories": [],
        "currency": "USD",
        "created_at": "2017-07-14T00:01:50Z",
        "updated_at": "2017-08-09T07:41:08Z",
        "campaign_id": "90r8n",
        "creative_source": "MANUAL",
        "deleted": true
      },
      "request": {
        "params": {
          "line_item_id": "9f2ix",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Kuratierte Kategorien für Line Items

In Postman öffnen

Weitere Details zur Nutzung finden Sie im Leitfaden zum Ziel „Video Views Pre‑roll“

​

GET accounts/:account_id/line_item_curated_categories

Rufen Sie Details zu einigen oder allen kuratierten Kategorien von Line Items ab, die dem aktuellen Account zugeordnet sind.

Resource URL

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

Parameters

Name	Description
account_id required	Der Bezeichner für den verwendeten Account. 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. Der angegebene Account muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 200 Min, Max: 1, 1000
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
sort_by optional	Sortiert nach einem unterstützten Attribut in aufsteigender oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließt das Antwortattribut total_count ein. Note: Dieser Parameter und cursor schließen sich gegenseitig aus. Note: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories

Example Response

    {
      "request": {
        "params": {
          "account_id": "abc1"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "by5pw",
          "curated_category_id": "7op29tp2jzeo",
          "id": "1",
          "created_at": "2018-06-29T04:19:53Z",
          "updated_at": "2018-06-29T04:19:53Z",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Ruft Details zu einer bestimmten kuratierten Kategorie eines Line Items ab, die dem aktuellen Konto zugeordnet ist.

Resource URL

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

Parameters

Name	Description
account_id required	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen, ausgenommen GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
line_item_curated_category_id required	Ein Verweis auf die kuratierte Kategorie des Line Items, mit der in der Anfrage gearbeitet wird. Type: string Example: 43853bhii885
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/abc1/line_item_curated_categories/yav

Example Response

    {
      "request": {
        "params": {
          "line_item_curated_category_id": "yav",
          "account_id": "abc1"
        }
      },
      "data": {
        "line_item_id": "by5pw",
        "curated_category_id": "7op29tp2jzeo",
        "id": "yav",
        "created_at": "2018-06-29T04:19:53Z",
        "updated_at": "2018-06-29T04:19:53Z",
        "deleted": false
      }
    }

​

POST accounts/:account_id/line_item_curated_categories

Weisen Sie dem angegebenen Line Item ein Objekt für eine kuratierte Kategorie zu.

Resource-URL

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

Parameter

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. Typ: string Beispiel: 18ce54d4x5t
curated_category_id required	Ein Verweis auf die kuratierte Kategorieentität, mit der Sie in der Anfrage arbeiten. Typ: string Beispiel: 10miy
line_item_id required	Ein Verweis auf das Line Item, mit dem Sie in der Anfrage arbeiten. Typ: string Beispiel: 8v7jo

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o

Beispielantwort

    {
      "request": {
        "params": {
          "curated_category_id": "9ddrgesiap6o",
          "line_item_id": "iqwka",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T17:26:42Z",
        "deleted": false
      }
    }

​

PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Aktualisiert die angegebene kuratierte Kategorie des Line Items.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
line_item_curated_category_id erforderlich	Ein Verweis auf die kuratierte Kategorie des Line Items, mit der Sie in der Anfrage arbeiten. Typ: string Beispiel: 1bzq3
curated_category_id optional	Ein Verweis auf die Entität der kuratierten Kategorie, mit der Sie in der Anfrage arbeiten. Typ: string Beispiel: 10miy
line_item_id optional	Ein Verweis auf das Line Item, mit dem Sie in der Anfrage arbeiten. Typ: string Beispiel: 8v7jo

Beispielanfrage

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g

Beispielantwort

    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "8tujl1p3yn0g",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

​

DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Löscht die angegebene kuratierte Kategorie des Line Items.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
line_item_curated_category_id erforderlich	Ein Verweis auf die kuratierte Kategorie des Line Items, mit der Sie in der Anfrage arbeiten. Typ: string Beispiel: 1bzq3

Beispielanfrage

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq

Beispielantwort

    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

​

Line-Item-Platzierungen

In Postman öffnen

​

GET line_items/placements

Rufen Sie gültige Kombinationen aus placement und product_type ab.

Resource-URL

https://ads-api.x.com/12/line_items/placements

Parameter

Name	Beschreibung
product_type optional	Beschränken Sie die Antwort auf die gültigen Placements für den angegebenen Produkttyp. Typ: enum Mögliche Werte: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS

Beispielanfrage

GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT

Beispielantwort

    {
      "data": [
        {
          "product_type": "PROMOTED_ACCOUNT",
          "placements": [
            [
              "ALL_ON_TWITTER"
            ],
            [
              "TWITTER_TIMELINE"
            ]
          ]
        }
      ],
      "request": {
        "params": {
          "product_type": "PROMOTED_ACCOUNT"
        }
      }
    }

​

Media Creatives

In Postman öffnen

​

GET accounts/:account_id/media_creatives

Rufen Sie Details zu einigen oder allen Media Creatives ab, die dem aktuellen Account zugeordnet sind.

Resource URL

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

Parameters

Name	Description
account_id required	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 Nutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
campaign_id optional	Beschränken Sie die Antwort auf die Media Creatives, die der angegebenen Kampagne zugeordnet sind. Type: string Example: 8gdx6
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
line_item_ids optional	Beschränken Sie die Antwort auf die Media Creatives, die den angegebenen Line Items zugeordnet sind, indem Sie eine durch Kommas getrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: 8v7jo
media_creative_ids optional	Beschränken Sie die Antwort auf die gewünschten Media Creatives, indem Sie eine durch Kommas getrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: 1bzq3
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließen Sie gelöschte Ergebnisse in die Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließt das Antwortattribut total_count ein. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3

Example Response

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "media_creative_ids": [
            "1bzq3"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8v7jo",
          "landing_url": "https://dev.x.com",
          "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
          "id": "1bzq3",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T06:00:42Z",
          "account_media_id": "10miy",
          "updated_at": "2019-01-11T20:21:26Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/media_creatives/:media_creative_id

Ruft Details zu einem bestimmten Media Creative ab, das dem aktuellen Account zugeordnet ist.

Resource URL

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

Parameters

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. Type: string Beispiel: 18ce54d4x5t
media_creative_id erforderlich	Ein Verweis auf das Media Creative, mit dem Sie in der Anfrage arbeiten. Type: string Beispiel: 43853bhii885
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Type: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3

Example Response

    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​

POST accounts/:account_id/media_creatives

Verknüpfen Sie ein Account Media-Objekt mit dem angegebenen Line Item.

Verwenden Sie dieses endpoint, um In-Stream-Anzeigen (wenn der Account-Media-creative_type PREROLL ist) oder Bildanzeigen (wie BANNER oder INTERSTITIAL) auf der Twitter Audience Platform zu schalten.

Hinweis: Um Medien-Assets zur Account-Media-Ressource hinzuzufügen, verwenden Sie das endpoint POST accounts/:account_id/media_library.

Resource URL

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

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 Benutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
account_media_id required	Ein Verweis auf die Account-Media-Entität, mit der Sie in der Anfrage arbeiten. Typ: string Beispiel: 10miy
line_item_id required	Ein Verweis auf das Line Item, mit dem Sie in der Anfrage arbeiten. Typ: string Beispiel: 8v7jo
landing_url sometimes required	Die URL der Website, zu der ein Nutzer weitergeleitet werden soll. Dies sollte nur mit TAP-Bildern (oder „Display Creatives“) verwendet werden. Dieser Wert wird ignoriert, wenn er mit Preroll-Assets verwendet wird. Um eine URL mit einem Preroll-Asset zu verknüpfen, verwenden Sie das endpoint POST accounts/:account_id/preroll_call_to_actions. Hinweis: Erforderlich, wenn das Ziel des Line Items auf WEBSITE_CLICKS gesetzt ist. Typ: string Beispiel: https://blog.x.com/

Example Request

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy

Example Response

    {
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "account_media_id": "10miy",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​

DELETE accounts/:account_id/media_creatives/:media_creative_id

Löscht das angegebene Media Creative, das dem aktuellen Account zugeordnet ist.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner des verwendeten Accounts. 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 Nutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
media_creative_id erforderlich	Ein Verweis auf das Media Creative, auf das sich die Anfrage bezieht. Typ: string Beispiel: 1bzq3

Beispielanfrage

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3

Beispielantwort

    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2021-04-16T21:02:55Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      }
    }

​

Promoted Accounts

In Postman öffnen

​

GET accounts/:account_id/promoted_accounts

Rufen Sie Details zu einigen oder allen beworbenen Accounts ab, die einem oder mehreren Line Items im aktuellen Account zugeordnet sind.

Verwenden Sie GET users/lookup, um Nutzerdaten für die in der Antwort durch user_id identifizierten Nutzerkonten zu erhalten.

Ein HTTP 400 wird zurückgegeben, wenn keines der angegebenen Line Items so konfiguriert ist, dass es beworbene Accounts enthält.

Resource URL

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

Parameters

Name	Beschreibung
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. Typ: string Beispiel: 18ce54d4x5t
count optional	Gibt die Anzahl der Datensätze an, die pro 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
line_item_ids optional	Beschränken Sie die Antwort auf die beworbenen Accounts, die den angegebenen Line Items zugeordnet sind, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übergeben werden. Typ: string Beispiel: 9bpb2
promoted_account_ids optional	Beschränken Sie die Antwort auf die gewünschten beworbenen Accounts, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übergeben werden. Typ: string Beispiel: 19pl2
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Typ: string Beispiel: created_at-asc
with_deleted optional	Schließt gelöschte Ergebnisse in die Antwort 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 festgelegt auf 200 pro 15 Minuten. Typ: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2

Example Response

    {
      "request": {
        "params": {
          "promoted_account_ids": [
            "19pl2"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "9bpb2",
          "user_id": "756201191646691328",
          "id": "19pl2",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T05:54:13Z",
          "updated_at": "2017-07-05T05:54:13Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/promoted_accounts/:promoted_account_id

Rufen Sie eine bestimmte Referenz auf ein Konto ab, das einem Line Item im aktuellen Konto zugeordnet ist.

Resource URL

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

Parameters

Name	Description
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API‑Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
promoted_account_id erforderlich	Die Referenz auf das beworbene Konto, mit dem Sie in der Anfrage arbeiten. Type: string Example: 19pl2
with_deleted optional	Gelöschte Ergebnisse in die Anfrage aufnehmen. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2

Example Response

    {
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​

POST accounts/:account_id/promoted_accounts

Ein Konto (user_id) mit dem angegebenen Line Item verknüpfen.

Wenn das angegebene Line Item nicht dafür konfiguriert ist, mit Promoted Accounts verknüpft zu werden, wird ein HTTP-400-Fehler INCOMPATIBLE_LINE_ITEM zurückgegeben. Wenn der angegebene Nutzer nicht für eine Promotion berechtigt ist, wird ein HTTP 400 zurückgegeben und es werden keine Nutzer beworben. Ist der angegebene Nutzer bereits beworben, wird die Anfrage ignoriert.

Weitere Informationen zu Promoted Accounts finden Sie auf unserer Seite zur Kampagnenverwaltung.

Hinweis: Es ist nicht möglich, Entitäten für beworbene Accounts zu aktualisieren (PUT).

Resource URL

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

Parameters

Name	Description
account_id required	Der Bezeichner für das genutzte 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. Type: string Example: 18ce54d4x5t
line_item_id required	Referenz auf das Line Item, mit dem Sie in der Anfrage arbeiten. Type: string Example: 9bpb2
user_id required	Referenz auf den Nutzer, mit dem Sie in der Anfrage arbeiten. Verwenden Sie GET users/lookup, um eine Nutzer-id für einen Screen-Namen abzurufen. Type: long Example: 756201191646691328

Example Request

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328

Example Response

    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED"
        "deleted": false
      },
      "request": {
        "params": {
          "user_id": "756201191646691328",
          "line_item_id": "9bpb2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

DELETE accounts/:account_id/promoted_accounts/:promoted_account_id

Die Verknüpfung eines Accounts mit dem angegebenen Line Item aufheben.

Resource URL

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

Parameters

Name	Description
account_id required	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 Nutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
promoted_account_id required	Der Bezeichner der Instanz eines Promoted Account, die einem Line Item zugeordnet ist. Type: string Example: 19pl2

Example Request

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2

Example Response

    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-08-23T18:53:15Z",
        "approval_status": "ACCEPTED"
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Promoted Tweets

In Postman öffnen

​

GET accounts/:account_id/promoted_tweets

Rufen Sie Verweise auf Tweets ab, die mit Line Items des aktuellen Accounts verknüpft sind.

Verwenden Sie das endpoint GET accounts/:account_id/tweets, um die Tweet-Objekte abzurufen. Nutzen Sie die tweet_id-Werte für jedes promoted_tweets-Objekt.

Hinweis: Wenn übergeordnete Line Items gelöscht werden, werden promoted_tweets nur zurückgegeben, wenn with_deleted=true in der Anfrage angegeben ist. Diese promoted_tweets sind jedoch nicht tatsächlich gelöscht ("deleted": false in der Antwort).

Resource URL

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

Parameters

Name	Beschreibung
account_id required	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
count optional	Gibt die Anzahl der Datensätze an, die pro 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
line_item_ids optional	Beschränken Sie die Antwort auf Tweets, die mit bestimmten Line Items verknüpft sind, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: 96uzp
promoted_tweet_ids optional	Beschränken Sie die Antwort auf die gewünschten Promoted Tweets, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: 1efwlo
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließt gelöschte Ergebnisse in die Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließt das Antwortattribut total_count ein. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen, die total_count beinhalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo

Example Response

    {
      "request": {
        "params": {
          "promoted_tweet_ids": [
            "1efwlo"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "96uzp",
          "id": "1efwlo",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-29T05:06:57Z",
          "updated_at": "2017-06-29T05:08:46Z",
          "approval_status": "ACCEPTED"
          "tweet_id": "880290790664060928",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/promoted_tweets/:promoted_tweet_id

Ruft einen spezifischen Verweis auf einen Tweet ab, der einem Line Item im aktuellen Konto zugeordnet ist.

Hinweis: Wenn übergeordnete Line Items gelöscht werden, werden promoted_tweets nur zurückgegeben, wenn with_deleted=true in der Anfrage angegeben ist. Diese promoted_tweets sind jedoch nicht tatsächlich gelöscht ("deleted": false in der Antwort).

Resource URL

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

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. Typ: string Beispiel: 18ce54d4x5t
promoted_tweet_id required	Ein Verweis auf den beworbenen Tweet, mit dem in der Anfrage gearbeitet wird. Typ: string Beispiel: 1efwlo
with_deleted optional	Gelöschte Ergebnisse in die Anfrage einschließen. Typ: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo

Example Response

    {
      "request": {
        "params": {
          "promoted_tweet_id": "1efwlo",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "96uzp",
        "id": "1efwlo",
        "entity_status": "ACTIVE",
        "created_at": "2017-06-29T05:06:57Z",
        "updated_at": "2017-06-29T05:08:46Z",
        "approval_status": "ACCEPTED"
        "tweet_id": "880290790664060928",
        "deleted": false
      }
    }

​

POST accounts/:account_id/promoted_tweets

Verknüpfen Sie einen oder mehrere Tweets mit dem angegebenen Line Item. Nicht alle Tweets eignen sich je nach Kampagnenziel für die Promotion. Weitere Informationen finden Sie unter Objective-based Campaigns.

Bei Verwendung des Produkttyps PROMOTED_ACCOUNT führt das Verknüpfen eines Tweets mit dem line_item zusätzlich zur standardmäßigen PROMOTED_ACCOUNT-Platzierung zu Timeline-Platzierungen auf Mobilgeräten.

Hinweis: Es ist nicht möglich, beworbene Tweet-Entitäten per PUT zu aktualisieren.

Resource URL

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

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
line_item_id erforderlich	Ein Verweis auf das Line Item, mit dem Sie in dieser Anfrage arbeiten. Typ: string Beispiel: 8v7jo
tweet_ids erforderlich	Eine kommagetrennte Liste von Bezeichnern für spezifische Tweets. Es können bis zu 50 IDs angegeben werden. Typ: long Beispiel: 822333526255120384

Example Request

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384

Example Response

    {
      "data": [
        {
          "line_item_id": "8v7jo",
          "id": "1e8i2k",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-24T04:21:36Z",
          "updated_at": "2017-06-24T04:21:36Z",
          "approval_status": "ACCEPTED"
          "tweet_id": "822333526255120384",
          "deleted": false
        }
      ],
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "tweet_ids": [
            822333526255120384
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "total_count": 1
    }

​

DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id

Hebt die Zuordnung eines Tweets vom angegebenen Line Item auf.

Hinweis: Eine gelöschte promoted_tweets-Entität wird in der ads.x.com-UI als „Pausiert“ angezeigt. Ebenso hebt das „Pausieren“ in der UI die Zuordnung des Tweets zu seinem Line Item auf.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen, mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
promoted_tweet_id erforderlich	Der Bezeichner bezieht sich auf die Instanz eines Promoted Tweet, die einem Line Item zugeordnet ist. Dieser Wert stammt aus dem Feld id eines Antwortelements von GET accounts/:account_id/promoted_tweets, nicht aus der tweet_id des betreffenden Tweets. Wird im Ressourcenpfad übergeben. Type: string Example: 1gp8a5

Example Request

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5

Example Response

    {
      "data": {
        "line_item_id": "9pl99",
        "id": "1gp8a5",
        "entity_status": "ACTIVE",
        "created_at": "2017-08-17T17:02:21Z",
        "updated_at": "2017-08-18T06:43:48Z",
        "approval_status": "ACCEPTED"
        "tweet_id": "844796297743757315",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_tweet_id": "1gp8a5",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Bewerbbare Nutzer

In Postman öffnen

​

GET accounts/:account_id/promotable_users

Rufen Sie Details für einige oder alle promotable Nutzer ab, die dem aktuellen Konto zugeordnet sind.

Der Typ eines promotable Nutzers ist entweder FULL oder RETWEETS_ONLY. Dies steuert, welche Art von Inhalten vom Konto beworben werden darf. Werbetreibende müssen die Erlaubnis einholen, Inhalte eines anderen Nutzers zu bewerben, und X kontaktieren, damit dieser als promotable Nutzer des Typs RETWEETS_ONLY zu Ihrem Konto hinzugefügt wird.

Wenn die Berechtigungen korrekt gesetzt sind, können Sie Anfragen an die promoted product endpoints stellen, die direkt auf die Tweet-ID des Tweets verweisen, den Sie bewerben möchten. Sie können das endpoint POST accounts/:account_id/promoted-tweets verwenden, um veröffentlichte Tweets zu bewerben, und das endpoint POST accounts/:account_id/scheduled-promoted-tweets, um Scheduled Tweets eines anderen Twitter Ads-Kontos zu bewerben.

Sie müssen den Ziel-Tweet nicht retweeten. Wenn Sie einen Tweet auf diese Weise bewerben, unterscheidet sich die zurückgegebene tweet_id von der bereitgestellten Tweet-ID. Im Hintergrund wird der Tweet als nullcasted Tweet retweetet und anschließend beworben. Die zurückgegebene tweet_id bezieht sich auf diesen neuen Tweet.

Resource URL

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

Parameters

Name	Beschreibung
account_id required	Der Bezeichner für das genutzte 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. Type: string Example: 18ce54d4x5t
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 200 Min, Max: 1, 1000
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
promotable_user_ids optional	Beschränken Sie die Antwort auf die gewünschten promotable Nutzer, indem Sie eine kommaseparierte Liste von Bezeichnern angeben. Es können bis zu 200 IDs bereitgestellt werden. Type: string Example: l310s
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Geschlossene Ergebnisse in die Anfrage einschließen. Type: boolean Default: false Possible values: true, false
with_total_count optional	Das Antwortattribut total_count einschließen. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s

Example Response

    {
      "request": {
        "params": {
          "promotable_user_ids": [
            "l310s"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "user_id": "756201191646691328",
          "id": "l310s",
          "created_at": "2016-07-21T22:42:09Z",
          "updated_at": "2016-07-21T22:42:09Z",
          "deleted": false,
          "promotable_user_type": "FULL"
        }
      ]
    }

​

GET accounts/:account_id/promotable_users/:promotable_user_id

Rufen Sie einen bestimmten promotable Nutzer ab, der dem aktuellen Konto zugeordnet ist.

Der Typ des promotable Nutzers ist entweder FULL oder RETWEETS_ONLY. Dies legt fest, welche Art von Inhalten vom Konto beworben werden darf.

Werbetreibende müssen die Berechtigung einholen, Inhalte eines anderen Nutzers zu bewerben. Wenn die Berechtigungen korrekt gesetzt sind, können Sie Anfragen an die Endpoints des beworbenen Produkts stellen, die direkt auf die Tweet-ID des Tweets verweisen, den Sie bewerben möchten.

Sie müssen den Ziel-Tweet nicht retweeten. Wenn Sie einen Tweet auf diese Weise bewerben, unterscheidet sich die zurückgegebene tweet_id von der bereitgestellten Tweet-ID. Hinter den Kulissen wird der Tweet als nullcasted Tweet retweetet und anschließend beworben. Die zurückgegebene tweet_id entspricht diesem neuen Tweet.

Resource URL

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

Parameters

Name	Description
account_id required	Der Bezeichner für das genutzte Konto. Erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
promotable_user_id optional	Ein Verweis auf den promotable Nutzer, auf den Sie sich in der Anfrage beziehen Type: string Example: l310s
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/promotable_users/l310s

Example Response

    {
      "request": {
        "params": {
          "promotable_user_id": "l310s",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "user_id": "2417045708",
        "id": "l310s",
        "created_at": "2017-03-10T17:51:24Z",
        "updated_at": "2017-03-10T17:51:24Z",
        "deleted": false,
        "promotable_user_type": "RETWEETS_ONLY"
      }
    }

​

Publisher

In Postman öffnen

​

GET publishers

Rufen Sie eine Liste mit Details zu Content-Category-Publishern ab

Weitere Details finden Sie im Leitfaden zum Ziel „Video Views Preroll“

Ressourcen-URL

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

Parameter

Keine Anfrageparameter

Beispielanfrage

GET https://ads-api.x.com/12/publishers

Beispielantwort

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "PeoplesSports",
          "user_id": "1353868435021721602",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "NewYork_Jack",
          "user_id": "1331177123436851206",
          "monetization_restricted": true,
          "content_category_ids": [
            "sk"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "twispatv",
          "user_id": "1331165719128461314",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "LAThieves",
          "user_id": "1316808678897455105",
          "monetization_restricted": true,
          "content_category_ids": [
            "s0"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Quicktake_EE",
          "user_id": "1305900477427724290",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "BR"
          ],
          "promotion_eligible_country_codes": [
            "BR"
          ],
          "username": "eufloribella",
          "user_id": "1300812459054436354",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "EG"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "Egypt2021EN",
          "user_id": "1296077573399678977",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "ClubShayShay",
          "user_id": "1283068366706454529",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "hiaahsanshow",
          "user_id": "1253421442143641601",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "TH"
          ],
          "promotion_eligible_country_codes": [
            "TH"
          ],
          "username": "HoneKrasae",
          "user_id": "1240684293719904256",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Sportskind",
          "user_id": "1232708694418300930",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "almeerathShow",
          "user_id": "1229410512762437633",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "SeeYourVoiceFOX",
          "user_id": "1225490734653947904",
          "monetization_restricted": true,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "AUProSports",
          "user_id": "1219303449768185859",
          "monetization_restricted": false,
          "content_category_ids": [
            "se"
          ]
        }
      ]
    }

​

Empfehlungen

In Postman öffnen

​

GET accounts/:account_id/recommendations

Status: Geschlossene Beta

Rufen Sie Kampagnenempfehlungen ab, die diesem Ads-Konto zugeordnet sind. Derzeit gilt ein Limit von 1 Empfehlung pro Zahlungsinstrument.

Resource URL

https://ads-api.x.com/5/accounts/:account_id/recommendations

Parameters

Name	Description
account_id required	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

Example Request

GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations

Example Response

    "request": {
      "params": {
        "account_id": "18ce54d4x5t"
      }
    },
    "total_count": 1,
    "data": [
      {
        "funding_instrument_id": "gpvzb",
        "id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t",
        "status": "PENDING",
        "message": "Empfehlung zum Testen"
        "created_at": "2016-11-14T23:07:54Z",
        "updated_at": "2016-11-14T23:07:54Z"
      }
    ]

​

GET accounts/:account_id/recommendations/:recommendation_id

Status: Geschlossene Beta

Rufen Sie eine bestimmte Kampagnenempfehlung ab, die diesem Ads-Konto zugeordnet ist.

Die Kampagnenempfehlung enthält einen vollständigen Satz an vorgeschlagenen Änderungen für die Kampagnenstruktur, dargestellt als Objektbaum. Der Antwortbaum ist für die Verwendung mit den Batch-API-endpoints vorgesehen, kann jedoch bei Bedarf auch auf einzelne Update-endpoints abgebildet werden (Create für POST, Update für PUT, Delete für DELETE).

Resource-URL

https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_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 Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
recommendation_id erforderlich	Ein Verweis auf die recommendation id, innerhalb derer Sie die Anfrage ausführen Type: string Example: 62ce8zza1q0w

Beispielanforderung

GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w

Beispielantwort

{
    "request": {
      "params": {
        "recommendation_id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t"
      }
    },
    "data_type": "recommendations",
      "data": {
      "changes": [
        {
          "entity_type": "campaigns",
          "params": {
            "start_time": "2016-11-08T22:00:00Z",
            "daily_budget_amount_local_micro": 2200000,
            "end_time": "2016-11-16T07:59:00Z",
            "total_budget_amount_local_micro": 12000000,
            "id": "64m0d"
          },
          "operation_type": "Update",
          "dependent_entities": [
            {
              "entity_type": "line_items",
              "params": {
                "name": "Kampagne für Empfehlungen",
                "placements": [
                  "TWITTER_TIMELINE"
                ],
                "bid_amount_local_micro": 1430000,
                "id": "6f5kq",
                "include_sentiment": "ALL"
              },
              "operation_type": "Update",
              "dependent_entities": [
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6p"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Wahlergebnisse",
                    "targeting_value": "Wahlergebnisse",
                    "targeting_type": "PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftp"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Männlich",
                    "targeting_value": 1,
                    "targeting_type": "GENDER"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "San Francisco–Oakland–San Jose CA, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101fto"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "91125952589766656"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Partner-Zielgruppen-Targeting",
                    "targeting_value": "v2cx",
                    "targeting_type": "NEGATIVE_BEHAVIOR"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "AGE_21_TO_34",
                    "targeting_value": "AGE_21_TO_34",
                    "targeting_type": "AGE"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6o"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991101965843460096"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991127212156096516"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Debatte",
                    "targeting_value": "Debatte",
                    "targeting_type": "NEGATIVE_PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "60004, IL, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6n"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftn"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                }
              ]
            }
          ]
        }
      ],
      "funding_instrument_id": "gpvzb",
      "id": "62ce8zza1q0w",
      "account_id": "18ce54d4x5t",
      "status": "PENDING"
      "message": "Empfehlung für Tests",
      "created_at": "2016-11-14T23:07:54Z",
      "updated_at": "2016-11-14T23:07:54Z"
      }
    }

​

Geplante beworbene Tweets

In Postman öffnen

​

GET accounts/:account_id/scheduled_promoted_tweets

Rufen Sie Details zu einigen oder allen geplanten beworbenen Tweets ab, die dem aktuellen Konto zugeordnet sind.

Resource URL

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

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 Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 200 Min, Max: 1, 1000
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
line_item_ids optional	Beschränken Sie die Antwort auf die geplanten Tweets, die bestimmten Line Items zugeordnet sind, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: 8xdpe
scheduled_promoted_tweet_ids optional	Beschränken Sie die Antwort auf die gewünschten geplanten beworbenen Tweets, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs angegeben werden. Type: string Example: 1xboq
sort_by optional	Sortiert nach einem unterstützten Attribut in auf- oder absteigender Reihenfolge. Siehe Sorting für weitere Informationen. Type: string Example: created_at-asc
with_deleted optional	Schließen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließen Sie das Antwortattribut total_count ein. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Type: boolean Default: false Possible values: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq

Example Response

    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_ids": [
            "1xboq"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8xdpe",
          "id": "1xboq",
          "created_at": "2017-06-01T19:53:32Z",
          "updated_at": "2017-06-01T20:00:06Z",
          "scheduled_tweet_id": "870366669373194240",
          "tweet_id": "870369382207070208",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

Rufen Sie einen bestimmten geplanten, beworbenen Tweet ab, der dem aktuellen Konto zugeordnet ist.

Resource URL

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

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 Beispiel: 18ce54d4x5t
scheduled_promoted_tweet_id erforderlich	Ein Verweis auf den geplanten, beworbenen Tweet, mit dem Sie in der Anfrage arbeiten. Type: string Beispiel: 1xboq
with_deleted optional	Schließen Sie gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq

Example Response

    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xboq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xboq",
        "created_at": "2017-06-01T19:53:32Z",
        "updated_at": "2017-06-01T20:00:06Z",
        "scheduled_tweet_id": "870366669373194240",
        "tweet_id": "870369382207070208",
        "deleted": false
      }
    }

​

POST accounts/:account_id/scheduled_promoted_tweets

Einen geplanten Tweet dem angegebenen Line Item zuordnen.

Hinweis: Geplante beworbene Tweet-Entities können nicht aktualisiert werden (PUT).

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte Konto. Er erscheint im Ressourcenpfad und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Benutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
line_item_id erforderlich	Referenz auf das Line Item, mit dem in der Anfrage gearbeitet wird. Typ: string Beispiel: 8xdpe
scheduled_tweet_id erforderlich	Referenz auf den geplanten Tweet, mit dem in der Anfrage gearbeitet wird. Typ: long Beispiel: 870358555227860992

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992

Beispielantwort

    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-08T07:25:26Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": false
      },
      "request": {
        "params": {
          "line_item_id": "8xdpe",
          "scheduled_tweet_id": 870358555227860992,
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

Lösen Sie einen geplanten Tweet vom angegebenen Line Item.

Hinweis: scheduled_promoted_tweets können nur vor dem scheduled_at-Zeitpunkt des geplanten Tweets gelöscht werden.

Ressourcen-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte 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
scheduled_promoted_tweet_id erforderlich	Ein Verweis auf den geplanten beworbenen Tweet, auf den sich die Anfrage bezieht. Dies ist das id-Attribut aus einem GET accounts/:account_id/scheduled_promoted_tweets-Antwortobjekt. Typ: string Beispiel: 1xtfl

Beispielanfrage

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl

Beispielantwort

    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-15T05:14:12Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": true
      },
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xtfl",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Targeting-Kriterien

In Postman öffnen

​

GET accounts/:account_id/targeting_criteria

Rufen Sie Details für einige oder alle Targeting-Kriterien ab, die mit Line Items unter dem aktuellen Account verknüpft sind.

Resource URL

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

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 Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
line_item_ids required	Beschränken Sie die Antwort auf die Targeting-Kriterien unter den angegebenen Line Items, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übermittelt werden. Type: string Example: 8u94t
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. Weitere Informationen finden Sie unter Pagination. Type: string Example: 8x7v00oow
lang optional	Ein ISO-639-1-Sprachcode. Wenn übermittelt, wird in der Antwort ein zusätzliches Attribut localized_name für Objekte zurückgegeben, für die ein lokalisierter Name verfügbar ist. Type: string Example: fr
sort_by optional	Sortiert nach einem unterstützten Attribut in aufsteigender oder absteigender Reihenfolge. Weitere Informationen finden Sie unter Sorting. Type: string Example: created_at-asc
targeting_criterion_ids optional	Beschränken Sie die Antwort auf die gewünschten Targeting-Kriterien, indem Sie eine kommagetrennte Liste von Bezeichnern angeben. Es können bis zu 200 IDs übermittelt werden. Type: string Example: dpl3a6
with_deleted optional	Schließt gelöschte Ergebnisse in Ihre Anfrage ein. Type: boolean Default: false Possible values: true, false
with_total_count optional	Schließt das Antwortattribut total_count ein. Note: Dieser Parameter und cursor schließen sich gegenseitig aus. Note: Anfragen, die total_count enthalten, unterliegen niedrigeren Rate Limits, derzeit 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/targeting_criteria?line_item_ids=8u94t

Example Response

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "8u94t"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8u94t",
          "name": "Targeting für benutzerdefinierte Zielgruppen",
          "id": "dpl3a6",
          "operator_type": "EQ",
          "created_at": "2017-05-26T03:29:35Z",
          "targeting_value": "249yj",
          "updated_at": "2017-05-26T03:29:35Z",
          "deleted": false
          "targeting_type": "CUSTOM_AUDIENCE"
        }
      ]
    }

​

GET accounts/:account_id/targeting_criteria/:targeting_criterion_id

Ruft ein bestimmtes Targeting-Kriterium ab, das dem aktuellen Konto zugeordnet ist.

Resource URL

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

Parameters

Name	Description
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. Typ: string Beispiel: 18ce54d4x5t
targeting_criterion_id required	Der Verweis auf das Targeting-Kriterium, mit dem in der Anfrage gearbeitet wird. Typ: string Beispiel: eijd4y
lang optional	Ein ISO-639-1-Sprachcode. Wenn übergeben, wird in der Antwort ein zusätzliches Attribut localized_name für Objekte zurückgegeben, für die ein lokalisierter Name verfügbar ist. Typ: string Beispiel: fr
with_deleted optional	Gelöschte Ergebnisse in die Anfrage einbeziehen. Typ: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y

Example Response

    {
      "request": {
        "params": {
          "targeting_criterion_id": "eijd4y",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "619jl",
        "name": "🤖",
        "id": "eijd4y",
        "created_at": "2017-07-06T16:51:04Z",
        "targeting_value": "🤖",
        "updated_at": "2017-07-06T16:51:04Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      }
    }

​

POST accounts/:account_id/targeting_criteria

Siehe die Seite Targeting Options, um targeting_value-Werte für bestimmte Targeting-Typen zu finden. Wir empfehlen, alle Daten wöchentlich zu aktualisieren, um sicherzustellen, dass Sie mit dem neuesten Satz an Targeting-Typwerten arbeiten. Wir ändern Werte und verfügbare Targeting-Kriterien von Zeit zu Zeit; die meisten ändern sich selten, einige jedoch schon. Es gibt keine Garantie, dass sich diese Werte nicht ändern.

Verwenden Sie die Targeting-Typen BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD oder UNORDERED_KEYWORD mit den im targeting_value angegebenen Keywords. Schließen Sie Keywords aus, indem Sie den Anfrageparameter operator_type auf NE setzen. Siehe targeting keyword types für eine detaillierte Beschreibung der einzelnen Typen.

Hinweis: Pro Line Item kann nur ein einzelner Alters-Bucket angesprochen werden.

Hinweis: Um eine Custom Audience zu targeten, muss diese targetable sein, d. h., targetable muss true sein.

Hinweis: Beim Verwenden des Targeting-Typs TV_SHOW muss mindestens ein LOCATION-Targeting-Kriterium am Line Item vorhanden sein, bevor das TV_SHOW-Targeting gesetzt wird, und alle LOCATION müssen derselben Locale entsprechen wie die anvisierte TV_SHOW.

Resource URL

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

Parameters

Name	Description
account_id required	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 Benutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
line_item_id required	Ein Verweis auf das Line Item, mit dem Sie in der Anfrage arbeiten. Type: string Example: 69ob
operator_type required	Geben Sie die Beziehung an, die das Targeting-Kriterium haben soll. Um beispielsweise Keywords auszuschließen, verwenden Sie operator_type=NE. Type: enum Possible values: EQ, NE, GTE, LT
targeting_type required	Der Targeting-Typ, der auf dieses Line Item angewendet wird. Mögliche nicht schlüsselwortbasierten Werte sind: AGE, DEVICE, EVENT, CAMPAIGN_ENGAGEMENT, CAMPAIGN_ENGAGEMENT_LOOKALIKE, CONVERSATION, ENGAGEMENT_TYPE, FOLLOWERS_OF_USER, GENDER, INTEREST, LANGUAGE, LIVE_TV_EVENT, LOCATION, NETWORK_ACTIVATION_DURATION, NETWORK_OPERATOR, PLATFORM, PLATFORM_VERSION, SIMILAR_TO_FOLLOWERS_OF_USER, TV_SHOW, USER_ENGAGEMENT, USER_ENGAGEMENT_LOOKALIKE, WIFI_ONLY Hinweis: Pro Line Item kann nur ein AGE-Bucket angesprochen werden. Mögliche schlüsselwortbasierte Werte sind: BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORD Mögliche Custom-Audience-Werte sind: CUSTOM_AUDIENCE, CUSTOM_AUDIENCE_EXPANDED Mögliche Werte für installierte App-Store-Kategorien: APP_STORE_CATEGORY, APP_STORE_CATEGORY_LOOKALIKE Möglicher Ausschluss für Twitter Audience Platform (TAP) Apps: APP_LIST (darf nur mit operator_type=NE verwendet werden)
targeting_value required	Geben Sie je nach ausgewähltem targeting_type an, auf welchen Nutzer, welches Interesse, welchen Standort, welches Ereignis, welche Plattform, welche Plattformversion, welches Gerät, welches Keyword oder welche Phrase, welches Geschlecht, welche Custom Audience, welche App-Store-Kategorie oder welchen Ausschluss einer App-Liste dieses Targeting angewendet wird. Type: string Example: 174958347

Example Request

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology

Beispielantwort

    {
      "data": {
        "line_item_id": "619jl",
        "name": "technology",
        "id": "fbyjlr",
        "created_at": "2017-09-06T07:31:21Z",
        "targeting_value": "technology",
        "updated_at": "2017-09-06T07:31:21Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      },
      "request": {
        "params": {
          "line_item_id": "619jl",
          "targeting_type": "BROAD_KEYWORD",
          "targeting_value": "technology",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

POST batch/accounts/:account_id/targeting_criteria

Ermöglicht das stapelweise Erstellen neuer Targeting-Kriterien mit einer einzelnen Anfrage.

Batch-Anfragen

• Die aktuelle maximale Batchgröße beträgt 500.
• Alle Parameter werden im Anfragetext übermittelt; ein Content-Type von application/json ist erforderlich.
• Batch-Anfragen schlagen als Gruppe fehl oder sind erfolgreich; alle API-Antworten behalten für Fehler- wie Erfolgsfälle die Reihenfolge der Elemente der ursprünglichen Anfrage bei.

Batch-Antworten

Batch-API-Antworten geben eine geordnete Sammlung von Elementen zurück. Ansonsten sind sie in ihrer Struktur mit den entsprechenden Single-Item-Endpoints identisch.

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. fehlender erforderlicher Parameter für Targeting-Kriterien) werden in der Antwort unter dem Objekt operation_errors angezeigt.

Resource-URL

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

Parameter

Name	Beschreibung
operation_type erforderlich	Der pro Element ausgeführte Operationstyp. Type: enum Mögliche Werte: Create, Delete
params erforderlich	Ein JSON-Objekt, das alle Parameter für die Objekte der Targeting-Kriterien enthält. Eine Liste der erforderlichen und optionalen Parameter für Targeting-Kriterien finden Sie hier. Zusätzlich unterstützt dieses Endpoint einen Parameter operator_type, der in Verbindung mit bestimmten targeting_type-Werten funktioniert. Die möglichen Werte für diesen Parameter sind EQ für gleich, GTE für größer oder gleich, LT für kleiner als und NE für ungleich.

Beispielanfrage

POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria

    [
      {
        "operation_type":"Create",
        "params":{
          "line_item_id":"6f9an",
          "targeting_type":"LOCATION",
          "targeting_value":"5122804691e5fecc"
        }
      },
      {
        "operation_type":"Delete"
        "params":{
          "targeting_criterion_id":"al2rua"
        }
      }
    ]

Beispielantwort

    {
      "data_type": "targeting_criterion",
      "data": [
        {
          "line_item_id": "6f9an",
          "name": "San Francisco–Oakland–San José, CA, USA",
          "id": "al7vt2",
          "location_type": "CITY",
          "operator_type": "EQ",
          "created_at": "2016-11-11T22:59:50Z",
          "targeting_value": "5122804691e5fecc",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": false,
          "targeting_type": "LOCATION"
        },
        {
          "line_item_id": "6keuo",
          "name": "Accounts"
          "id": "al2rua",
          "operator_type": "EQ",
          "created_at": "2016-11-11T17:50:19Z",
          "targeting_value": "accounts",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": true,
          "targeting_type": "BROAD_KEYWORD"
        }
      ],
      "request": [
        {
          "params": {
            "line_item_id": "6f9an",
            "targeting_type": "LOCATION",
            "targeting_value": "5122804691e5fecc",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        },
        {
          "params": {
            "targeting_criterion_id": "al2rua",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Delete"
        }
      ]
    }

​

DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id

Löscht das angegebene Targeting-Kriterium, das dem aktuellen Account zugeordnet ist.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner des genutzten Accounts. 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 Beispiel: 18ce54d4x5t
targeting_criterion_id erforderlich	Ein Verweis auf das Targeting-Kriterium, auf das sich die Anfrage bezieht. Type: string Beispiel: dpl3a6

Example Request

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6

Example Response

    {
      "data": {
        "line_item_id": "8u94t",
        "name": "Zielgruppen-Targeting für benutzerdefinierte Audiences",
        "id": "dpl3a6",
        "created_at": "2017-05-26T03:29:35Z",
        "targeting_value": "249yj",
        "updated_at": "2017-08-30T18:38:58Z",
        "deleted": true,
        "targeting_type": "CUSTOM_AUDIENCE"
      },
      "request": {
        "params": {
          "targeting_criterion_id": "dpl3a6",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Targeting-Optionen

In Postman öffnen

• App-Store-Kategorien
• Konversationen
• Geräte
• Ereignisse
• Interessen
• Sprachen
• Standorte
• Netzbetreiber
• Plattformversionen
• Plattformen
• TV-Märkte
• TV-Sendungen

​

GET targeting_criteria/app_store_categories

Entdecken Sie verfügbare Targeting-Kriterien auf Basis von App-Store-Kategorien für Promoted Products. App-Store-Kategorien sind nur für den iOS App Store und den Google Play Store verfügbar.

Das Targeting nach installierten App-Kategorien ermöglicht das Ansprechen von Nutzern anhand der Kategorien der Apps, die sie installiert haben oder für die sie Interesse bekundet haben.

Resource URL

https://ads-api.x.com/12/targeting_criteria/app_store_categories

Parameters

Name	Description
q optional	Eine optionale query, um ein Targeting-Kriterium einzugrenzen. Lassen Sie diesen Parameter weg, um alle abzurufen. Type: string Example: music
os_type optional	Ergebnisse auf einen bestimmten App Store eingrenzen. Type: enum Possible values: ANDROID, IOS

Example Request

GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS

Example Response

    {
      "data": [
        {
          "name": "Games: Music",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qouq",
          "os_type": "IOS"
        },
        {
          "name": "Music",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qov2",
          "os_type": "IOS"
        }
      ],
      "request": {
        "params": {
          "q": "music"
          "os_type": "IOS"
        }
      }
    }

​

GET targeting_criteria/conversations

Ermitteln Sie verfügbare konversationsbasierte Targeting-Kriterien für Promoted Products.

Resource URL

https://ads-api.x.com/12/targeting_criteria/conversations

Parameters

Name	Description
conversation_type optional	Optionale Abfrage zur Eingrenzung auf einen bestimmten Konversationstyp. Type: enum Mögliche Werte: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES
count optional	Gibt die Anzahl der Datensätze an, die pro Anfrage abgerufen werden sollen. Type: 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. Type: string Beispiel: 8x7v00oow

Example Request

GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2

Example Response

    {
      "request": {
        "params": {
          "count": 2
        }
      },
      "next_cursor": "1f7m7",
      "data": [
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a1",
          "name": "NFL",
          "conversation_type": "SPORTS",
        },
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a2",
          "name": "NBA",
          "conversation_type": "SPORTS"
        }
      ]
    }

​

GET targeting_criteria/devices

Ermitteln Sie verfügbare, gerätebasierte Targeting-Kriterien für Promoted Products. Geräte-Targeting ist für Promoted Tweets verfügbar.

Resource URL

https://ads-api.x.com/12/targeting_criteria/devices

Parameters

Name	Description
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 200 Min, Max: 1, 1000
q optional	Optionale query, um ein Targeting-Kriterium einzuschränken. Lassen Sie diesen Parameter weg, um alle abzurufen. Type: string Example: apple

Example Request

GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone

Example Response

    {
      "data": [
        {
          "name": "iPhone 3GS",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1q",
          "targeting_type": "DEVICE"
        },
        {
          "name": "iPhone 4",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1r",
          "targeting_type": "DEVICE"
        }
      ],
      "request": {
        "params": {
          "q": "iPhone",
          "count": 2
        }
      }
    }

​

GET targeting_criteria/events

Entdecken Sie verfügbare ereignisbasierte Targeting-Kriterien für Promoted Products. Pro Line Item kann nur ein Ereignis ausgerichtet werden.

Hinweis: Ereignisse erstrecken sich häufig über mehrere Zeitzonen, was die Betrachtung von Ereigniszeiten aus zeitzonenübergreifender Perspektive erschwert. Zur Vereinfachung werden alle start_time- und end_time-Werte für Ereignisse an diesem endpoint in UTC±00:00 dargestellt, unabhängig von Region und Zeitzone des jeweiligen Ereignisses. Dieses Design sollte beim Abfragen und Umgang mit den start_time- und end_time-Werten von Ereignissen berücksichtigt werden. Beispielsweise wird der Independence Day in den USA in UTC±00:00 als start_time=2017-07-04T00:00:00Z und end_time=2017-07-05T00:00:00Z dargestellt und vermeidet so das Problem, dass dieser Feiertag innerhalb der USA mehrere Zeitzonen umfasst.

Resource URL

https://ads-api.x.com/12/targeting_criteria/events

Parameters

Name	Beschreibung
event_types erforderlich	Eine optionale Abfrage zur Eingrenzung auf bestimmte Ereignistypen. Type: enum Mögliche Werte: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS
count optional	Gibt an, wie viele Datensätze pro einzelner Anfrage abgerufen werden sollen. Type: int Standard: 200 Min, Max: 1, 1000
country_codes optional	Eine optionale Abfrage, um die Suche nach Targeting-Kriterien auf bestimmte Länder mit dem 2‑stelligen ISO-Ländercode einzugrenzen. Wenn dieser Parameter nicht angegeben ist, werden alle Ereignisse zurückgegeben. Type: string
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Beispiel: 8x7v00oow
end_time optional	Der Zeitpunkt, ausgedrückt in ISO 8601, zu dem die Kampagne endet. Type: string Beispiel: 2017-10-05T00:00:00Z
start_time optional	Der Zeitpunkt, ausgedrückt in ISO 8601, zu dem das Line Item mit der Auslieferung beginnt. Hinweis: Standardmäßig die aktuelle Zeit. Type: string Beispiel: 2017-07-05T00:00:00Z

Example Request

GET https://ads-api.x.com/12/targeting_criteria/events?count=1

Example Response

    {
      "request": {
        "params": {
          "count": 1
        }
      },
      "data_type": "events",
      "data": [
        {
          "reach": {
            "total_reach": null
          },
          "name": "New Year's",
          "start_time": "2017-12-31T00:00:00Z",
          "top_users": [],
          "top_tweets": [],
          "top_hashtags": [],
          "gender_breakdown_percentage": {},
          "end_time": "2018-01-02T00:00:00Z",
          "country_code": null,
          "device_breakdown_percentage": {},
          "targeting_value": "1ex",
          "is_global": true,
          "event_type": "HOLIDAY"
          "country_breakdown_percentage": {}
        }
      ],
      "next_cursor": "uww0"
    }

​

GET targeting_criteria/interests

Ermitteln Sie verfügbare interessenbasierte Targeting-Kriterien für Promoted Products. Interessen ändern sich selten; dennoch empfehlen wir, diese Liste mindestens einmal wöchentlich zu aktualisieren.

Resource URL

https://ads-api.x.com/12/targeting_criteria/interests

Parameters

Name	Beschreibung
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
q optional	Eine optionale Abfrage zur Eingrenzung eines Targeting-Kriteriums. Lassen Sie diesen Parameter weg, um alle abzurufen. Type: string Example: books

Example Request

GET https://ads-api.x.com/12/targeting_criteria/interests?q=books

Example Response

    {
      "data": [
        {
          "name": "Bücher und Literatur/Biografien und Erinnerungen",
          "targeting_type": "INTEREST",
          "targeting_value": "1001"
        }
      ],
      "request": {
        "params": {
          "q": "books",
          "count": 1
        }
      },
      "next_cursor": "6by4n4"
    }

​

GET targeting_criteria/languages

Ermitteln Sie die für das Targeting verfügbaren Sprachen.

Resource URL

https://ads-api.x.com/12/targeting_criteria/languages

Parameters

Name	Description
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
q optional	Optionale Abfrage zum Eingrenzen der Targeting-Kriterien. Lassen Sie diesen Parameter weg, um alle abzurufen. Type: string Example: english

Example Request

GET https://ads-api.x.com/12/targeting_criteria/languages?q=english

Example Response

    {
      "data": [
        {
          "name": "Englisch",
          "targeting_type": "LANGUAGE",
          "targeting_value": "en"
        }
      ],
      "request": {
        "params": {
          "q": "English"
        }
      },
      "next_cursor": null
    }

​

GET targeting_criteria/locations

Entdecken Sie verfügbare standortbasierte Targeting-Kriterien für Promoted Products. Geo-Targeting ist für Promoted Accounts und Promoted Tweets auf Länder-, Bundesstaat-/Regions-, Stadt- und Postleitzahlenebene verfügbar. Postleitzahlen-Targeting muss verwendet werden, wenn Sie Analysen auf Postleitzahlenebene abrufen möchten.

Hinweis: Um bestimmte targetbare Städte wie San Francisco oder New York abzurufen, verwenden Sie die Enum CITIES mit dem Anfrageparameter location_type.

Um Designated Market Areas (DMAs) zu adressieren, verwenden Sie die Enum METROS.

Resource URL

https://ads-api.x.com/12/targeting_criteria/locations

Parameters

Name	Beschreibung
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 200 Min, Max: 1, 1000
country_code optional	Eine optionale Abfrage, um die Suche nach Targeting-Kriterien auf ein bestimmtes Land mit dem zweistelligen ISO-Ländercode zu beschränken. Lassen Sie diesen Parameter weg, um Ergebnisse für alle Länder abzurufen. Type: string Example: JP
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
location_type optional	Beschränken Sie die Ergebnisse auf eine bestimmte Art von Standort. Granulareres Targeting als COUNTRIES ist möglicherweise nicht überall verfügbar. Type: enum Possible values: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES
q optional	Eine optionale Abfrage, um die Suche nach Targeting-Kriterien einzugrenzen. Lassen Sie diesen Parameter weg, um alle Ergebnisse abzurufen. Type: string Example: New York

Example Request

GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles

Example Response

    {
      "data": [
        {
          "name": "Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "3b77caf94bfc81fe",
          "targeting_type": "LOCATION"
        },
        {
          "name": "East Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "67571a7baaa5906b",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Lake Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "ea9bfbd43c93400f",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Gatos, San Francisco–Oakland–San Jose CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "a2de7c70b82b0ca0",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Altos, Monterey–Salinas CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "6a4364ea6f987c10",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Banos, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "b1b6fc646de75904",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Alamitos, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "0799ff0a3c1006e9",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Angeles, US",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "019940ae78c7b3bc",
          "targeting_type": "LOCATION"
        }
      ],
      "request": {
        "params": {
          "location_type": "CITIES",
          "q": "los angeles"
        }
      },
      "next_cursor": null
    }

​

GET targeting_criteria/network_operators

Ermitteln Sie verfügbare, netzbetreiberbasierte Targeting-Kriterien für Promoted Products.

Dieses endpoint ermöglicht es Ihnen, targetbare Netzbetreiber wie AT&T, Verizon, Sprint, T-Mobile usw. in mehreren Ländern nachzuschlagen.

Resource URL

https://ads-api.x.com/12/targeting_criteria/network_operators

Parameters

Name	Description
count optional	Gibt die Anzahl der Datensätze an, die pro separater Anfrage abgerufen werden sollen. Type: int Default: 200 Min, Max: 1, 1000
country_code optional	Eine optionale Abfrage, um eine Suche nach Targeting-Kriterien auf ein bestimmtes Land mit dem 2‑stelligen ISO-Ländercode zu beschränken. Wenn dieser Parameter nicht angegeben ist, werden nur Partnerzielgruppen für die Vereinigten Staaten zurückgegeben. Type: string Default: US
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
q optional	Eine optionale Abfrage, um eine Suche nach Targeting-Kriterien einzugrenzen. Lassen Sie diesen Parameter weg, um alle Ergebnisse abzurufen. Type: string Examples: Airpeak

Example Request

GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US

Example Response

    {
      "data": [
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Advantage",
          "targeting_value": "2l"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Aeris",
          "targeting_value": "1b"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airadigm",
          "targeting_value": "2t"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airlink PCS",
          "targeting_value": "14"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airpeak"
          "targeting_value": "1i"
        }
      ],
      "request": {
        "params": {
          "country_code": "US",
          "count": 5
        }
      },
      "next_cursor": "o7x9iet1a5u608olj4"
    }

​

GET targeting_criteria/platform_versions

Ermitteln Sie verfügbare Targeting-Kriterien auf Basis von Versionen mobiler Betriebssysteme für Promoted Products. Targeting nach Plattformversionen ist für Promoted Accounts und Promoted Tweets verfügbar. Damit ist Targeting bis zur Punktversion eines mobilen Betriebssystems möglich, etwa Android 8.0 oder iOS 10.0.

Resource URL

https://ads-api.x.com/12/targeting_criteria/platform_versions

Parameters

Name	Beschreibung
q optional	Eine optionale Abfrage, um die Suche nach Targeting-Kriterien einzugrenzen. Lassen Sie diesen Parameter weg, um alle Ergebnisse abzurufen. Type: string Beispiele: jelly bean

Example Request

GET https://ads-api.x.com/12/targeting_criteria/platform_versions

Example Response

    {
        "data": [
            {...},
            {
                "name": "Ice Cream Sandwich",
                "number": "4.0",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "17"
            },
            {
                "name": "Jelly Bean",
                "number": "4.1",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "18"
            },
            {...}
        ],
        "data_type": "targeting_criterion",
        "request": {
            "params": {}
        }
    }

​

GET targeting_criteria/tv_markets

Ermitteln Sie verfügbare TV‑Märkte, auf die TV‑Sendungen ausgerichtet werden können. Gibt Märkte nach Locale zurück, die zum Abfragen des Endpoints GET targeting_criteria/tv_shows verwendet werden können.

Resource URL

https://ads-api.x.com/12/targeting_criteria/tv_markets

Parameters

Keine

Example Request

GET https://ads-api.x.com/12/targeting_criteria/tv_markets

Example Response

    {
      "data": [
        {
          "name": "Frankreich",
          "country_code": "FR",
          "locale": "fr-FR"
        },
        {
          "name": "Chile",
          "country_code": "CL",
          "locale": "es-CL"
        },
        {
          "name": "Deutschland",
          "country_code": "DE",
          "locale": "de-DE"
        },
        {
          "name": "Niederlande",
          "country_code": "NL",
          "locale": "nl-NL"
        },
        {
          "name": "Vereinigte Staaten",
          "country_code": "US",
          "locale": "en-US"
        },
        {
          "name": "Venezuela",
          "country_code": "VE",
          "locale": "es-VE"
        },
        {
          "name": "Brasilien",
          "country_code": "BR",
          "locale": "pt-BR"
        },
        {
          "name": "Mexiko",
          "country_code": "MX",
          "locale": "es-MX"
        },
        {
          "name": "Kolumbien",
          "country_code": "CO",
          "locale": "es-CO"
        },
        {
          "name": "Vereinigtes Königreich",
          "country_code": "GB",
          "locale": "en-GB"
        },
        {
          "name": "Argentinien",
          "country_code": "AR",
          "locale": "es-AR"
        },
        {
          "name": "Japan",
          "country_code": "JP",
          "locale": "ja-JP"
        },
        {
          "name": "Kanada",
          "country_code": "CA",
          "locale": "en-CA"
        },
        {
          "name": "Spanien",
          "country_code": "ES",
          "locale": "es-ES"
        },
        {
          "name": "Italien",
          "country_code": "IT",
          "locale": "it-IT"
        },
        {
          "name": "Vereinigte Staaten – Hispanisch",
          "country_code": "US",
          "locale": "es-US"
        },
        {
          "name": "Irland",
          "country_code": "IE",
          "locale": "en-IE"
        }
      ],
      "request": {
        "params": {}
      }
    }

​

GET targeting_criteria/tv_shows

Ermitteln Sie verfügbare, auf TV-Sendungen basierende Targeting-Kriterien für Promoted Products. TV-Show-Targeting ist in bestimmten Märkten für Promoted Tweets verfügbar. Siehe den endpoint GET targeting_criteria/tv_markets für verfügbare Märkte.

Hinweis: Jede Zielgruppe mit weniger als 1.000 Nutzern wird mit einem estimated_users-Wert von 1000 angezeigt.

Hinweis: Targeting-Optionen für TV-Sender und Genres werden nicht mehr unterstützt.

Resource URL

https://ads-api.x.com/12/targeting_criteria/tv_shows

Parameters

Name	Beschreibung
locale required	Ein erforderlicher Parameter, der die tv_market_locale angibt, für die verfügbare TV-Sendungen abgefragt werden. TV-Märkte werden basierend auf der von GET targeting_criteria/tv_markets zurückgegebenen locale abgefragt. Type: string Example: en-US
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 50 Min, Max: 1, 50
cursor optional	Gibt einen Cursor an, um die nächste Ergebnisseite abzurufen. Siehe Pagination für weitere Informationen. Type: string Example: 8x7v00oow
q optional	Eine optionale Abfrage, um die Suche nach Targeting-Kriterien einzugrenzen. Lassen Sie diesen Parameter weg, um alle Ergebnisse abzurufen. Type: string Examples: ios, blackberry

Example Request

GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1

Example Response

    {
      "data": [
        {
          "name": "NewsWatch",
          "targeting_value": 10027243420,
          "genre": "PAID",
          "locales": [
            {
              "language": "en",
              "country": "US"
            }
          ]
        }
      ],
      "next_cursor": "c-22838-zdQDJrTxSvOYfQOhb2IlGQ",
      "request": {
        "params": {
          "locale": {
            "countryCode": "US",
            "languageCode": "en"
          },
          "count": 1,
          "q": "news"
        }
      }
    }

​

Targeting-Empfehlungen

In Postman öffnen

​

GET accounts/:account_id/targeting_suggestions

Rufen Sie bis zu 50 Keyword- oder Nutzer-Targeting-Vorschläge ab, um Ihre initiale Auswahl zu ergänzen.

Resource URL

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

Parameters

Name	Description
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 authentifizierenden Nutzer zugeordnet sein. Type: string Example: 18ce54d4x5t
suggestion_type required	Geben Sie den Typ der zurückzugebenden Vorschläge an. Type: enum Possible values: KEYWORD, USER_ID
targeting_values required	Durch Kommas getrennte Sammlung von entweder Keywords oder Nutzer-IDs, die als Grundlage für die Vorschläge dienen. Hinweis: Diese beiden Vorschlagstypen können nicht gemischt werden. Example: 756201191646691328
count optional	Gibt die Anzahl der Datensätze an, die pro einzelner Anfrage abgerufen werden sollen. Type: int Default: 30 Min, Max: 1, 50

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"

Example Response

    {
      "data": [
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "devs"
        },
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "software"
        }
      ],
      "request": {
        "params": {
          "suggestion_type": "KEYWORD",
          "targeting_values": [
            "developers"
          ],
          "count": 2,
          "account_id": "18ce54d4x5t"
        }
      }
    }

​

Steuereinstellungen

In Postman öffnen

​

GET accounts/:account_id/tax_settings

Rufen Sie Details zu den Steuereinstellungen ab, die dem aktuellen Konto zugeordnet sind.

Resource URL

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

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 Beispiel: 18ce54d4x5t

Example Request

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

Example Response

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Inc.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

​

PUT accounts/:account_id/tax_settings

Aktualisieren Sie die Steuereinstellungen für das aktuelle Konto.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist in der Regel ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
address_city optional	Die Stadt in der Adresse des Kontoinhabers. Typ: string Beispiel: San Francisco
address_country optional	Der zweibuchstabige Ländercode für die Adresse des Kontoinhabers. Typ: string Beispiel: US
address_email optional	Die mit der Adresse des Kontoinhabers verknüpfte E-Mail-Adresse. Typ: string Beispiel: [e-mail]
address_first_name optional	Der Vorname in der Adresse des Kontoinhabers. Typ: string Beispiel: API
address_last_name optional	Der Nachname in der Adresse des Kontoinhabers. Typ: string Beispiel: McTestface
address_name optional	Der Firmenname in der Adresse des Kontoinhabers. Typ: string Beispiel: ABC, Co.
address_postal_code optional	Die Postleitzahl in der Adresse des Kontoinhabers. Typ: string Beispiel: 94102
address_region optional	Die Region in der Adresse des Kontoinhabers. Typ: string Beispiel: California
address_street1 optional	Die erste Straßenzeile in der Adresse des Kontoinhabers. Typ: string Beispiel: 21 March St
address_street2 optional	Die zweite Straßenzeile in der Adresse des Kontoinhabers. Typ: string Beispiel: Suite 99
bill_to optional	Die zu belastende Partei. Typ: enum Mögliche Werte: ADVERTISER, AGENCY
business_relationship optional	Ob das Konto dem Werbetreibenden oder der Agentur gehört. Typ: enum Mögliche Werte: AGENCY, SELF
client_address_city optional	Die Stadt in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: Toronto
client_address_country optional	Der zweibuchstabige Ländercode für die Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: CA
client_address_email optional	Die mit der Adresse des Werbetreibenden verknüpfte E-Mail-Adresse. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: [e-mail]
client_address_first_name optional	Der Vorname in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: Brand
client_address_last_name optional	Der Nachname in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: Advertiser
client_address_name optional	Der Firmenname in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: Brand, Inc.
client_address_postal_code optional	Die Postleitzahl in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: M5H 2N2
client_address_region optional	Die Region in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: Ontario
client_address_street1 optional	Die erste Straßenzeile in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: 280 Queen St W
client_address_street2 optional	Die zweite Straßenzeile in der Adresse des Werbetreibenden. Legen Sie dies fest, wenn das Werbekonto von einer Agentur gehalten wird. Typ: string Beispiel: The 6
invoice_jurisdiction optional	Zuständigkeit für die Rechnungsstellung. Typ: enum Mögliche Werte: LOI_SAPIN, NONE, NOT_SET
tax_category optional	Ob die Besteuerung privat oder geschäftlich erfolgen soll. Typ: enum Mögliche Werte: BUSINESS_NO_VAT, BUSINESS_WITH_VAT, INDIVIDUAL
tax_exemption_id optional	USt.-Befreiungs-ID. Typ: string Beispiel: 12345
tax_id optional	USt.-Registrierungs-ID. Typ: string Beispiel: 67890

Beispielanfrage

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.

Beispielantwort

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "address_name": "ABC Co."
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC Co.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

​

Tracking-Tags

In Postman öffnen

​

GET accounts/:account_id/tracking_tags

Rufen Sie Details für einige oder alle dem aktuellen Account zugeordneten Tracking-Tags ab.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner für den verwendeten Account. 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. 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	Cursor zum Abrufen der nächsten Ergebnisseite. Siehe Pagination für weitere Informationen. Typ: string Beispiel: 8x7v00oow
line_item_ids optional	Beschränkt die Antwort auf die Tracking-Tags, die mit bestimmten Line Items verknüpft sind, indem eine kommagetrennte Liste von Bezeichnern angegeben wird. Es können bis zu 200 IDs übergeben werden. Typ: string Beispiel: 96uzp
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
tracking_tag_ids optional	Beschränkt die Antwort auf die gewünschten Tracking-Tags, indem eine kommagetrennte Liste von Bezeichnern angegeben wird. Es können bis zu 200 IDs übergeben werden. Typ: string Beispiel: 3m82
with_deleted optional	Geschlossene Ergebnisse in die Anfrage einbeziehen. Typ: boolean Standard: false Mögliche Werte: true, false
with_total_count optional	Das Antwortattribut total_count einbeziehen. Hinweis: Dieser Parameter und cursor schließen sich gegenseitig aus. Hinweis: Anfragen mit total_count unterliegen niedrigeren Rate Limits, derzeit 200 pro 15 Minuten. Typ: boolean Standard: false Mögliche Werte: true, false

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82

Example Response

    {
      "request": {
        "params": {
          "tracking_tag_ids": [
            "3m82"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "fdwcl",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "tracking_tag_type": "IMPRESSION_TAG",
          "id": "3m82",
          "created_at": "2019-06-26T17:04:26Z",
          "updated_at": "2019-06-26T17:04:26Z",
          "deleted": false
        }
      ]
    }

​

GET accounts/:account_id/tracking_tags/:tracking_tag_id

Ruft ein bestimmtes Tracking-Tag ab, das dem aktuellen Konto zugeordnet ist.

Ressourcen-URL

https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_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. Typ: string Beispiel: 18ce54d4x5t
tracking_tag_id erforderlich	Der Verweis auf das Tracking-Tag, auf das sich die Anfrage bezieht. Typ: string Beispiel: 555j
with_deleted optional	Einschließlich gelöschter Ergebnisse in der Anfrage. Typ: boolean Standard: false Mögliche Werte: true, false

Beispielanfrage

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j

Beispielantwort

    {
      "request": {
        "params": {
          "with_deleted": true,
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2020-08-13T23:02:03Z",
        "deleted": false
      }
    }

​

POST accounts/:account_id/tracking_tags

Verknüpfen Sie einen Tracking-Tag mit dem angegebenen Line Item.

Resource URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Pfad der Ressource und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
line_item_id erforderlich	Ein Verweis auf das Line Item, mit dem Sie in der Anfrage arbeiten. Typ: string Beispiel: 8v7jo
tracking_tag_type erforderlich	Der Typ des Tracking-Tags. Typ: enum Mögliche Werte: IMPRESSION_TAG, CLICK_TRACKER
tracking_tag_url erforderlich	Die vom Tracking-Partner bereitgestellte Tracking-Tag-URL. Typ: string Beispiel: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

Beispielanfrage

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

Beispielantwort

    {
      "request": {
        "params": {
          "line_item_id": "fdwcl",
          "tracking_tag_type": "IMPRESSION_TAG",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2019-06-26T17:04:26Z",
        "deleted": false
      }
    }

​

PUT accounts/:account_id/tracking_tags/:tracking_tag_id

Einem angegebenen Line Item ein Tracking-Tag zuordnen.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das genutzte 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. Typ: string Beispiel: 18ce54d4x5t
tracking_tag_url erforderlich	Die vom Tracking-Partner bereitgestellte Tracking-Tag-URL. Typ: string Beispiel: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

Beispielanfrage

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309

Beispielantwort

    {
      "request": {
        "params": {
          "tracking_tag_id": "3m82",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2022-01-26T17:04:26Z",
        "deleted": false
      }
    }

​

DELETE accounts/:account_id/tracking_tags/:tracking_tag_id

Lösen Sie das Tracking-Tag vom angegebenen Line Item.

Resource-URL

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

Parameter

Name	Beschreibung
account_id erforderlich	Der Bezeichner für das verwendete Konto. Er erscheint im Ressourcenpfad und ist im Allgemeinen ein erforderlicher Parameter für alle Advertiser-API-Anfragen mit Ausnahme von GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Typ: string Beispiel: 18ce54d4x5t
tracking_tag_id erforderlich	Eine Referenz auf das Tracking-Tag, mit dem Sie in der Anfrage arbeiten. Typ: string Beispiel: 555j

Beispielanfrage

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j

Beispielantwort

    {
      "request": {
        "params": {
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2021-08-29T17:12:58Z",
        "deleted": true
      }
    }

​

Nutzer­einstellungen

In Postman öffnen

(https://app.getpostman.com/run-collection/1d12b9fc623b8e149f87)

​

GET accounts/:account_id/user_settings/:user_id

Ruft Nutzereinstellungen ab.

Resource URL

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

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. Type: string Example: 18ce54d4x5t
user_id erforderlich	Ein Verweis auf den Nutzer, in dessen Kontext die Anfrage ausgeführt wird. Verwenden Sie GET users/lookup, um eine Nutzer-id für einen Screen-Namen abzurufen. Type: long Example: 756201191646691328

Example Request

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328

Example Response

      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
          }
        },
        "data": {
          "notification_email": "[e-mail]",
          "contact_phone": "",
          "contact_phone_extension": ""
        }
      }

​

PUT accounts/:account_id/user_settings/:user_id

Aktualisiert die Nutzereinstellungen. Erfordert Nutzerkontext. Für Konto-Administratoren nicht zugänglich.

Resource URL

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

Parameters

Name	Beschreibung
account_id erforderlich	Der Bezeichner des genutzten Kontos. Erscheint im Ressourcenpfad und bei GET accounts. Das angegebene Konto muss dem authentifizierten Nutzer zugeordnet sein. Type: string Beispiel: 18ce54d4x5t
user_id erforderlich	Referenz auf den Nutzer, in dessen Kontext die Anfrage ausgeführt wird. Verwenden Sie GET users/lookup, um eine Nutzer-id zu einem Screen-Namen abzurufen. Type: long Beispiel: 756201191646691328
notification_email optional	E-Mail-Adresse für Kontobenachrichtigungen. Type: string Beispiel: [e-mail]
contact_phone optional	Telefonnummer für Kontaktzwecke. Type: string Beispiel: 202-555-0128
contact_phone_extension optional	Durchwahl zu contact_phone. Type: string Beispiel: 1234

Example Request

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='[e-mail]'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"

Example Response

      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
            "notification_email": "[e-mail]",
            "subscribed_campaign_events": [
              "ACCOUNT_PERFORMANCE",
              "PERFORMANCE_IMPROVEMENT"
            ]
          }
        },
        "data": {
          "notification_email": "[e-mail]",
          "contact_phone": "",
          "Contact_phone_extension": ""
        }
      }