メインコンテンツへスキップ
X Ads API の過去バージョンに関する最新情報は、以下をご参照ください。
バージョンパス導入日非推奨日サポート終了日
12.0/12/2022年10月27日未定未定
11.0/11/2022年3月31日未定未定
10.0/10/2021年8月31日2022年3月31日2022年10月27日
9.0/9/2021年3月2日2021年8月31日2022年3月31日
8.0/8/2020年9月8日2021年3月2日2021年8月31日
7.0/7/2020年3月3日2020年9月1日2021年3月2日
6.0/6/2019年8月28日2020年3月3日2020年9月1日
5.0/5/2019年2月28日2019年8月28日2020年3月3日
4.0/4/2018年8月28日2019年2月28日2019年8月28日
3.0/3/2018年2月1日2018年8月28日2019年2月28日
2.0/2/2017年7月10日2018年2月1日2018年8月1日
1.0/1/2016年3月31日2017年7月7日2018年1月10日
0.0/0/2013年2月21日該当なし2016年10月31日

​
概要

私たちは毎月、X Ads API に変更を加え、複数の新機能をリリースしています。これらの変更はほとんどの場合、後方互換性がありますが、年間にいくつかの破壊的変更が発生することがあります。新機能の実装、非推奨への対応、変更のテストにおいて、Ads API の迅速な変更サイクルが開発サイクルに与える課題について、開発者の皆様からフィードバックをいただいています。Ads プラットフォームにおける開発者体験を改善するため、私たちは endpoint のバージョニングという概念を導入しました。 以下は本書で用いるいくつかの概念の定義です。 Version: Ads API リクエストの URL パスに含まれるバージョン番号を指します。例: GET //accounts。 このバージョニング方式は URI バージョニングとして知られています。 Breaking Changes: 破壊的変更とは、既存機能を維持するために開発リソースを要するあらゆる変更を指します。これには、必要な変更点の調査、非推奨となる機能/endpoint の特定、これらの最終実装に要するリソースが含まれます。破壊的変更の例は次のとおりです。
  • API リクエスト/レスポンスから param を削除する
  • 任意の param や endpoint の名称を変更する
  • 値の表現を変更する（preview_url → card_uri）
  • endpoint の動作を変更する（例: 非同期 vs 同期の統計）
  • 任意または必須の param を追加/変更する（例: リクエストで name を必須フィールドにする）
Deprecation: 非推奨となったバージョンやプロダクトはサポート対象外となり、これらの API の使用は中止が推奨されます。 Sunset: プロダクトまたは API がサンセットされると、対応する一連の endpoint には API 経由でアクセスできなくなります。

​
バージョニング戦略

この戦略の主な原則は次のとおりです。
  1. 互換性を破壊する変更は、すべて新しいバージョンにまとめてリリースします
  2. 新しいバージョンが告知された時点で、既存バージョンの非推奨期間は6か月となります
  3. 任意の時点で、APIは同時に2つのバージョンからのリクエストを受け付けますが、2つのうち古い方はサポート対象外です
  4. 新製品の採用を迅速化するため、これらは継続的（バージョニングのケイデンス外）にリリースされます
  5. すべてのAPIレスポンスには x-current-api-version が含まれ、APIの現在のバージョンが設定されます。さらに、非推奨のAPI endpoint を呼び出す際には x-api-warn ヘッダーが付与されます。
製品の根本的な要件変更によりAPIの互換性を破壊する変更（例: 複数の年齢バケット・ターゲティングの非推奨）が必要な場合は、この変更を告知する90日前通知を配信し、通知の発出から少なくとも90日後に当該の互換性破壊の変更をデプロイします

​
v9

本日、2021年3月3日、X Ads API の Version 9（v9）が提供開始されました。本リリースは、機能の整合性の向上、キャンペーン作成の簡素化に加え、Cards および Mobile App Promotion の endpoint に対する重要な更新の導入を目的としています。 これまでのバージョンと同様に、v9 への移行期間は 6 か月です。2021年8月31日をもって、既存の Version 8（v8）の Ads API は利用できなくなります。サービス中断を回避するため、可能な限り早期に最新の Ads API へ移行してください。
注記: 本リリース時点で、Ads API の Version 7（v7）はサポートが終了し、利用できなくなりました。
詳細は、developer forum のアナウンスをご覧ください。

​
v8

本日、2020年9月20日、X Ads API のバージョン 8 をリリースしました。新たな Tailored Audiences 機能の導入、ads.x.com との機能同等性の向上、そして開発者エクスペリエンスの改善を目的としています。 従来のバージョンと同様、v8 への移行には 6 か月の移行期間があります。2021-03-02 をもって X Ads API のバージョン 7 はご利用いただけなくなります。サービス中断を回避するため、可能な限り早急に最新バージョンの API へ移行いただくことを推奨します。 詳細は、開発者フォーラムでのアナウンスをご覧ください。

​
v7

本日、2020年3月20日、ads.x.com との機能整合性を高めるため、X Ads API のバージョン 7 をリリースします。 これまでのバージョンと同様に、v7 への移行期間として 6 か月を設けています。2020-09-01 以降、Ads API のバージョン 6 はご利用いただけなくなります。サービス中断を避けるため、可能な限り早急に最新バージョンの API へ移行されることを推奨します。なお、Ads API のバージョン 5 はすでにサポート終了となっており、ご利用いただけません。 詳細は、developer forum の告知をご覧ください。

​
v6

本日、2019年8月28日、X は開発者エクスペリエンスの向上と一貫性に焦点を当てた更新を含む Ads API v6 を公開します。 このリリースには、Tweet を取得するための新しい endpoint、Promoted Accounts の統計、名称によるエンティティ検索機能、非同期アナリティクス処理ジョブの現行件数に関する情報が含まれます。さらに、メディアを使用する endpoint とターゲティング条件の endpoint に対し、一貫性を高める更新を実施しました。最後に、一部のパラメータ名およびレスポンス属性を軽微に更新し、Scoped Timeline endpoint を非推奨とします。 詳細は、開発者フォーラムでのアナウンスをご覧ください。

​
v5

本日2019年2月28日、X はスケールと効率の向上に焦点を当てた更新を含む Ads API v5 をリリースしました。 本リリースには、指定期間にどのエンティティがアクティブだったかを判定する新たな endpoint、Media Creatives（例：X Audience Platform 上の In-stream 動画および画像）の統計、カード URI を用いた_複数_カードの取得機能、さらにターゲティング条件やその他のエンティティの取得に関する柔軟性の向上が含まれます。加えて、いくつかのバグ修正とパラメータ名およびレスポンス属性の更新を行いました。最後に、非メディアの App カードおよび POST accounts/:account_id/account_media endpoint は非推奨となりました。 これまでのバージョンと同様に、v5 への移行には 6 か月の移行期間があります。2019-08-28 以降、X Ads API のバージョン 4 は利用できなくなります。サービス中断を回避するため、すべてのパートナーの皆様には可能な限り早期に最新の API バージョンへ移行いただくことを推奨します。X Ads API のバージョン 3 はサポート終了となっており、すでに利用できません。

​
新機能

どのエンティティがアクティブかの判定 Active Entities エンドポイントは、広告エンティティの分析用 metrics に変更があったかどうかを示します。分析用エンドポイントと併用する設計で、Active Entities はエンティティの type と日付範囲（最大 90 日）を指定して動作し、プラットフォームが分析をリクエストすべきエンティティ ID の配列を返します。返されなかった ID は、後続の分析リクエストで照会すべきではありません。 このエンドポイントは次のエンティティ type をサポートします: CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, MEDIA_CREATIVE, PROMOTED_TWEET。 MEDIA_CREATIVE の統計情報 X Ads API の分析エンドポイントで、Media Creative エンティティ向けの metrics が提供されるようになりました。Media Creative は、X Audience Platform 上のインストリーム広告や画像をプロモーションするための仕組みです。X Ads の UI では、Media Creative の metrics は「In-stream videos」と「Display creatives」タブに表示されます。同期および非同期の両方の分析エンドポイントが MEDIA_CREATIVE エンティティの列挙値をサポートします。 複数のカードを取得 カードの URI 値で単一のカードを取得するために設計されたエンドポイントのv3 リリースを改良し、GET accounts/:account_id/cards/all エンドポイントを使用して_複数_のカードを取得できるようになりました。これにより、カードごとにリクエストを送るのではなく、1 回のリクエストで最大 200 件のカードを取得できます。 注意点は次の 2 つです。
  1. URL パスは accounts/:account_id/cards/all になりました（以前のパスは利用できません）。ID でカードを取得するために設計された同エンドポイントとの一貫性を保つためです。
  2. 必須のリクエストパラメータ名は複数形の card_uris になりました。
取得の柔軟性向上 GET accounts/:account_id/targeting_criteria エンドポイントは、複数の line item ID をサポートするようになりました。最大 200 件の ID を受け付ける line_item_ids パラメータが必須です。従来は単一の line item しか受け付けられず、同期が困難でした。今回の変更により、より多くのターゲティングを短時間で取得できます。 以下のエンドポイントも複数の line item ID をサポートしますが、これらでは line_item_ids パラメータは任意です。

​
変更

ドラフトのキャンペーンとラインアイテムの取得 ドラフトのキャンペーンおよびラインアイテムの取得方法が更新されました。with_draft(boolean) パラメータを true に設定すると、ドラフトと非ドラフトの両方のエンティティが返されます。これは削除済みエンティティの取得方法（with_deleted を使用）と一致します。以前は、ドラフトと非ドラフトの両方のエンティティを取得するには少なくとも 2 回のリクエストが必要でしたが、現在は 1 回の API 呼び出しで可能です。 | v4 | v5 | | :--- | :--- | :--- | | draft_only | with_draft | | Network activation duration ターゲティング X Ads API は、Network Activation Duration ターゲティングを追加した後に、レスポンスのターゲティング type に _IN_SEC サフィックスが含まれてしまう表示上の問題を解消しました。Network Activation Duration は常に月単位で表されるため、秒を参照するのは紛らわしいものでした。本修正により表現が統一され、混乱が軽減されます。 | v4 | v5 | | :--- | :--- | :--- | | NETWORK_ACTIVATION_DURATION_IN_SEC | NETWORK_ACTIVATION_DURATION | | 合計件数とカーソル v5 では、with_total_count と cursor は排他的です。リクエストで両方を指定すると、EXCLUSIVE_PARAMETERS エラーコードが返されます。v5 以前では、cursor が指定された場合、with_total_count は無視されていました。この変更により、その関係が明示されます。

​
削除

X Ads API のレスポンスから3つのフィールドが削除されます：preview_url、account_id、parent_ids。これら3点に対するエンジニアリング上の対応は最小限です。
  • v4 では、カードのレスポンスパラメータ preview_url は常に null であると告知していました。この移行の最終段階として、すべてのカードのレスポンスから preview_url を削除します。
  • 次のリソースについては、URL および request.params に広告アカウント ID がすでに含まれているため、レスポンス属性 account_id を削除します。（資金提供手段は意図的にこの一覧から除外しています。可能な限り、親 ID はレスポンスオブジェクトに含まれるべきであり、アカウント ID は資金提供手段の親エンティティであるためです。）
    • Account media
    • App event providers
    • App event tags
    • Campaigns
    • Cards
    • Line items
    • Promotable users
    • Targeting criteria
  • GET accounts/:account_id/targeting_criteria リクエストでは、parent_ids フィールドは常に空配列であったため、今後は返しません。
非メディア App カード v5 では、非メディア App カードはサポート対象外となりました。これに先立ち、非メディア App カードの作成・編集機能はすでに削除されています。今回、このリソースの残りの endpoint を非推奨化します。
  • 注：これは画像および動画のアプリダウンロードカードには影響しません。
Account media の作成 POST accounts/:account_id/account_media endpoint は v5 では利用できません。このリソースの他の endpoint には影響しません。変更理由は、Media Library にメディアを追加する際、場合によってはそのアセットが自動的に Account Media エンティティとして追加され、既存アセットを Account Media リソースに追加しようとするとエラーになるためです。これは以下の場合に発生します。
  • Media Library に追加された AMPLIFY_VIDEO アセットは、クリエイティブ type が PREROLL の Account Media アセットとして自動的に追加されます。
  • 特定の寸法の画像を Media Library に追加すると、自動的に Account Media アセットとして追加されます。クリエイティブ type（例：INTERSTITIAL）は画像の寸法に依存します。（寸法については Enumerations ページを参照してください。）

​
v4

X Ads API のバージョン 4 は本日、2018 年 8 月 28 日にリリースされます。 このリリースでは、より堅牢なオーディエンス処理バックエンドを基盤とする新しい API インターフェースを含む Audiences 製品の改良を提供します。バージョン 4 には、ユーザー、アカウント、税設定を管理するための一連の endpoint も含まれています。さらに、accounts/:account_id/videos endpoint は非推奨となります。本リリースには、いくつかの軽微なパラメータおよびレスポンス名の変更も含まれています。 バージョン 3 と同様に、6 か月の移行期間を提供します。2019-02-28 以降、X Ads API バージョン 3 はご利用いただけなくなります。サービス中断を回避するため、すべてのパートナーの皆様は可能な限り早期に最新バージョンの API へ移行してください。バージョニング戦略の詳細は Versions ページをご覧ください。

​
新機能

Audience API 新しい Audiences API は、堅牢性と信頼性を強化した新しいオーディエンス処理バックエンド上に構築されています。この新しい endpoint により、パートナーは単一のユーザーに対して複数種類のユーザー識別子を提供でき、これにより照合に追加のシグナルを活用できます。新しい Audience endpoint のリファレンスドキュメントはこちらをご参照ください。今年の残り期間を通じて、本製品のアップデートと改善を継続的にリリースしていく予定です。 以下の endpoint は、機能が重複しているため v4 では利用できなくなります（v3 では引き続き動作し、v3 の提供終了時に完全にサンセットされます）:
  • TON Upload:
    • GET accounts/:account_id/tailored_audience_changes
    • GET accounts/:account_id/tailored_audience_changes/:tailored_audience_change_id
    • POST accounts/:account_id/tailored_audience_changes
    • PUT accounts/:accounti_d/tailored_audiences/global_opt_out
  • Real Time Audiences:
    • POST tailored_audience_memberships
最後に、バージョン 4 では、すべての Tailored Audiences endpoint のリクエストおよびレスポンスから list_type パラメータが削除されます。 Settings Endpoints アカウント管理者は、ユーザー、アカウント、税務の各設定を構成・更新できるようになりました。User settings は、特定の広告アカウントにおけるユーザー固有の連絡先設定に対応します。PUT accounts/:account_id endpoint を使用して、広告主はアカウント名と業種を更新できます。最後に、tax settings endpoint では、付加価値税（VAT）が課される国の広告主が、会社名、住所、VAT ID、アカウントの所有者（広告主本人か、広告主に代わって広告を実施する代理店か）といった情報を更新できます。

​
変更点

Universal Lookalike の名称変更 POST accounts/:account_id/line_items および PUT accounts/:accountit/line_items/:line_item_id の各endpointにおける lookalike_expansion パラメータの enum 値を更新します。
v3v4
NARROWDEFINED
BALANCEDEXPANDED
あらゆる箇所で country_code を使用 X Ads API の一貫性向上の一環として、以下のendpointにおけるパラメータ名を app_country_code から country_code に変更します。 これは、これらのパラメータの動作や受け付ける値には影響せず、名称のみの変更です。 preview_url は常に null v3 のアナウンスどおり、既存のすべてのカードに card_uri が付与されました。結果として、preview_url の値は常に null になります。 念のためのご案内として、card_uri の値を使用してカードを Tweet に関連付けてください。以下はリクエスト例です。 $ twurl -X POST -H ads-api.x.com “/4/accounts/18ce54d4x5t/tweet?text=Version 4&card_uri=card://958225772740714496”

​
削除

Video endpoints accounts/:account_id/videos endpoints は v4 で利用できなくなります。これらの endpoints は Media Library endpoints の導入により廃止されました。以下の利用方法の比較を参照してください。
  • v3 videos endpoint: twurl -H ads-api.x.com "/3/accounts/18ce54d4x5t/videos"
  • v4 の動画向け Media Library endpoint: twurl -H ads-api.x.com "/4/accounts/18ce54d4x5t/media_library?media_type=VIDEO"
Media Library endpoints は videos endpoints と機能同等であり、画像や GIF の取り扱いなどの追加機能もサポートします。パートナーの皆様は、メディア管理には Media Library を専用でご利用ください。 as_user_id in Tweet View GET accounts/:account_id/tweet/preview/:tweet_id endpoint で利用可能だった as_user_id パラメータは、今後受け付けられません。プレビューは常に Tweet の作者としてレンダリングされます。

​
v3

X Ads API のバージョン 3 は 2018 年 2 月 1 日にリリースされました。X Ads API のバージョン 2 は 2018 年 8 月 1 日にサポート終了となります。 このリリースには、新しい Audience Intelligence 製品、Media Library へのアクセス、カードのワークフローの改善が含まれます。あわせて、PUT accounts/:account_id/targeting_criteria endpoint の非推奨化を発表します。最後に、バージョン 3 では、いくつかの軽微なパラメータおよびレスポンスの変更と、バッチサイズ上限の引き下げが含まれます。 version 2 と同様に、パートナーには移行期間として6 か月を提供します。2018-08-01 に Ads API の v2 は停止されます。すべてのパートナーおよび開発者に、可能な限り早期に v3 への移行を推奨します。 Audience Intelligence Audience Intelligence は、特定の X オーディエンスに最も関連性の高い上位のハッシュタグ、@handles、イベントに関するリアルタイムのインサイトを提供します。たとえば、米国で Male 18-34 を指定すると、このオーディエンスで #nintendoswitch、#cardinal、@ricegum がトレンドになっていることが分かります。 Audience Intelligence のendpointsは、次の機能を提供します。
  • 入力オーディエンスに基づき、関連性の高い上位のハッシュタグ、@handles、イベントを取得します。
  • 入力オーディエンスに基づき、主要なデモグラフィック情報（年齢、性別、世帯収入など）を取得します。
  • キーワードに基づき、Tweet ボリュームの時系列データを取得します。
Media Library Media Library は、広告アカウント向けに画像、GIF、動画を管理する機能を提供します。これらのメディアオブジェクトは、Tweets で使用したり、カードの作成に利用できます。また、複数のクリエイティブで再利用できるため、同一アセットを繰り返しアップロードする必要がなくなります。 ライブラリ内のオブジェクトは media_key によって識別されます。media key は、たとえば 13_875943225764098048 のような形式の文字列です。Ads API では、すべてのメディアで media key を使用する方向に移行しています。 カードのワークフロー改善 すべての cards endpoint は、現在 media key をサポートしています。これにより、Media Library 内のオブジェクトを使用してカードを作成または更新できるようになります。 さらに、カード詳細の取得のための 2 つの新しい endpoint を導入します。これらの endpoint は、たとえば Tweets または Scheduled Tweets で使用されているカードを、card_uri または id のいずれかを指定して照会する用途に利用できます。以前はこれはできませんでした。

​
その他の変更

これらの新機能に加えて、バージョン3には以下の変更が含まれます。 新規
  • GET insights/keywords/search endpoint のレスポンスに、入力キーワードに関連する用語を最大30件含む related_keywords 属性が追加されました。
変更
  • ターゲティング条件の一括処理の最大サイズは500になりました。
  • レスポンス属性の card_uri と preview_url は相互排他になりました。カードに card_uri がある場合、preview_url は null になります。カードに card_uri がない場合は preview_url のみが返されます。
    • 2018-01-29 以降に作成されたすべてのカードには card_uri が付きます。
    • バージョン4までに、既存のすべてのカードに card_uri が付きます。
  • 5:2 画像を用いたカードを新規作成することはできなくなりました。既存の 5:2 画像ベースのカードは引き続き利用可能ですが、可能な箇所ではパフォーマンスの高い 1.91:1 または 1:1 のアスペクト比への移行を推奨します。
削除 注記 Video Website Cards と Scheduled Tweets はベータ版を終了しました。ローンチ以降に Scheduled Tweets に加えた変更については、このスレッドを参照してください。Scheduled Tweets の HTML previews を生成できる機能も含まれます。

​
v2

X Ads API のバージョン 2 は 2017 年 7 月 10 日にリリースされました。X Ads API のバージョン 1 は 2018 年 1 月 10 日にサポート終了（EOL）となります。 互換性を破る変更／廃止
  • total_count はレスポンス属性として任意になりました。with_total_count が true に設定されている場合にのみ返されます
  • line_items および campaigns のリクエスト／レスポンスオブジェクトにある paused と draft_only fields は、単一の entity_status パラメータに置き換えられました
  • POST accounts/:account_id/tweet および GET accounts/:account_id/tweet/preview endpoint において、status パラメータは text に改名されました
  • GET targeting_criteria/locations endpoint の location_type 列挙値は複数形になりました。COUNTRY は COUNTRIES、REGION は REGIONS など。唯一の例外として、v2 では CITY が METROS になり、ロケーションタイプが Designated Market Areas (DMA) すなわち「メトロエリア」を指すことを正しく反映します
  • PUT accounts/:account_id/promoted_tweets endpoints の display_properties は廃止されました。この値はレスポンスにも含まれなくなります
  • 前項の結果、promoted_tweets エンティティを更新（PUT）することはできなくなりました
  • GET accounts/:account_id/promoted_tweets endpoint の line_item_id パラメータは削除されました
  • v2 endpoints では 5:2 Website Cards を作成できなくなります
  • data_type レスポンス属性は返されなくなりました
新機能
  1. Cards v2
  2. 下書きキャンペーン／ラインアイテムの作成と有効化
  3. 予約投稿（Scheduled Tweets）
  4. 非同期ジョブのサマリー
Cards v2
  • Tweet にカードを関連付ける際は、Tweet テキストに preview_url を付与するのではなく、card_uri リクエストパラメータを使用してください
  • （カード作成ステップ中の）レスポンスで card_uri パラメータが返らない場合は、preview_url を使用してください
  • すべての新しいカード形式は card_uri パラメータを活用して API 上でネイティブに利用可能になります
新しいカード形式: Draft Campaigns 下書きキャンペーンは GET accounts/:account_id/campaigns endpoint で閲覧可能でした。v2 では、API を通じて下書きキャンペーンを作成・有効化できるようになりました。
下書きキャンペーン下書きラインアイテム
funding_instrument_idcampaign_id
nameobjective
start_timeproduct_type
placements
注記
  • 下書きのラインアイテムまたはキャンペーンは、entity_status を DRAFT から PAUSED または ACTIVE にのみ変更できます
  • 複数のラインアイテムを含むキャンペーン全体を有効化するには、キャンペーン配下の各ラインアイテムとキャンペーン自体の entity_status をいずれも ACTIVE に設定する必要があります。
  • キャンペーンまたはラインアイテムの entity_status を変更するには、対応する PUT endpoint を使用します。
Scheduled Tweets

​
v1

X Ads API のバージョン 1 は 2016年3月31日にリリースされ、2018年1月10日にサポート終了となりました。 バージョン 1 の変更点:
  • バージョン管理のサポート
  • CUSTOM objective のサポートは終了しました
  • Batch endpoints は一般提供を開始しました
  • リーチ推定の変更点:
  • より精度の高いリーチ推定を行うため、当該 endpoint は予算に対応するようになりました。以下のパラメータが必須になりました：
    • [new] campaign_daily_budget_amount_local_micro
    • currency
    • bid
    • objective
  • レスポンスオブジェクトが変更され、レスポンス値の範囲を返すようになりました。
  • infinite_count は、その用途に関する混同を避けるため infinite_bid_count に名称変更されました
  • count と infinite_bid_count に加え、次の新たなデータポイントが返されます：
    • impressions
    • engagements
    • estimated_daily_spend_local_micro
  • テーラードオーディエンスの data の type の変更
  • Tailored Audiences の data_type は、すべてのレスポンスで tailored_audiences から tailored_audience に変更されました。
  • 「共有 Tailored Audiences」は現在、API 限定のベータ版として提供されています。共有 Tailored Audiences を使用すると、1 つのオーディエンスを複数の広告アカウント間で利用できます。広告アカウント間で共有したい Tailored Audience の権限を管理するには、POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions（および関連）endpoint を使用してください。
  • 広告主アカウントのパフォーマンスアナリティクスの収集方法が大幅に改善されました：
  • 当社のベストプラクティスに沿い、同期型の統計endpointでは、取得できるdataを最大7日間分までに制限します。
  • metrics の取得を簡素化するため、metrics パラメータを新しい metric_groups パラメータに置き換えました。開発者は、特定のリクエストで返却を希望する metrics のグループを指定して要求するだけで済みます。
    • 対象のエンティティに適合しない metrics をリクエストした場合、それらはレスポンスから除外され、null 値として返されます。これらの metrics はアナリティクスのコスト上限には計上されません。
  • レスポンスは大幅に簡素化され、UI における metrics の表示方法とより密接に一致するようになりました。
    • 以前は掲載場所ごと（Search の Promoted Tweets、Timelines の Promoted Tweets、Profiles & Tweet Details の Promoted Tweets、X Audience Platform）に別個の指標を提供していました。今後は、各カテゴリに対して標準化された一連の metrics を返します（promoted_tweet_timeline_impressions、promoted_tweet_search_impressions、promoted_tweets_profile_impressions、promoted_tweets_tpn_impressions の代替として）。以下のいずれかのカテゴリーでリクエストされた場合、単一の指標 impressions として提供されます（これはすべての metrics に適用されます）:
    • ALL_ON_TWITTER
    • PUBLISHER_NETWORK
    • リクエスト時には、UI 上の値と照合しやすいよう、単一の impressions 指標が返されます。
    • ALL_ON_TWITTER と PUBLISHER_NETWORK の両方の data を取得するには、これらは結合できないため、2 件のクエリを実行する必要があります。
  • 非同期統計のendpoint が、開発者のフィードバックに基づき、提供開始されました。
    • すぐに必要ではないデータや過去データの取得に向けて、統計を非同期でリクエストできる新しい一連のendpoint。
    • 新しい単一のendpointで統計ジョブをキューに投入します。リソース状況に応じて、こちらでご指定のdataを取得します。
    • dataが利用可能か確認するため、ジョブステータスのendpointに対してqueryを実行できます。
    • dataが利用可能になったら、同期endpointのレスポンスを反映したJSONレスポンスをダウンロードできるよう、受け取り用のpick-up IDを提供します。
    • 1つのジョブで最大90日分、最大20エンティティのdataをqueryできます。
  • v0 の metrics を v1 の metrics へマッピングした内容を含む analytics v1 移行ガイドをご覧ください
  • Sandbox の改善点 * これからは Sandbox 環境で複数のテスト広告アカウントを作成できます。 * Sandbox 環境限定で、テスト用広告アカウントに複数の支払い手段（資金手段）を作成できるようになりました。これにより、すべての資金手段タイプでテストできます。以前はテストに利用できる資金手段は CREDIT_CARD のみでした。 * ベータ機能をテストしたい場合は、Sandbox 環境でアカウント単位に機能のオン/オフを切り替えられるようになりました。テストのニーズに合わせてご利用ください。

​
v0

X Ads API のバージョン 0 は 2013 年 2 月 21 日に正式リリースされ、2016 年 10 月 31 日までサポートされました。 バージョン 0 のすべてのアナリティクス関連 endpoint は非推奨となり、2016 年 10 月 31 日以降は提供されません。これらの endpoint は、バージョン 1 の 3 つのアナリティクス endpoint に置き換えられました。 リーチ推定の endpoint は、バージョン 1 で挙動が変更されています。
⌘I