メインコンテンツへスキップ
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 プラットフォームを利用する開発者体験を向上させるため、エンドポイントのバージョニングという概念を導入しました。 以下は、本書で使用するいくつかの概念の定義です。 バージョン: Ads API リクエストの URL パスに含まれるバージョン番号を指します。例: GET //accounts。 このバージョニング手法は URI バージョニングとして知られています。 破壊的変更: 既存の機能を維持するために開発リソースを要する変更を指します。これには、必要な変更点の調査、非推奨となる機能/エンドポイントの特定、ならびにそれらすべての最終実装に必要なリソースが含まれます。破壊的変更の例としては次のようなものがあります。
  • API のリクエスト/レスポンスからパラメータを削除する
  • パラメータ名またはエンドポイント名を変更する
  • 値の表現方法の変更(preview_url → card_uri)
  • エンドポイントの動作変更(例: 非同期と同期の統計)
  • 任意または必須パラメータの追加/変更(例: リクエストで name を必須フィールドにする)
非推奨: 非推奨となったバージョンまたは製品はサポート対象外となり、開発者はこれらの API の使用を中止することが推奨されます。 サンセット: 製品または API がサンセットされると、該当する一連のエンドポイントは API を通じてアクセスできなくなります。

バージョニング戦略

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

v9

本日、2021年3月3日、X Ads API のバージョン 9(v9)が公開されました。本リリースは、機能の同等性の向上、キャンペーン作成の簡素化、そして Cards および Mobile App Promotion エンドポイントへの重要な更新の導入を目的としています。 従来バージョンと同様に、v9 への移行期間は 6 か月です。2021年8月31日をもって、既存のバージョン 8(v8)の Ads API はご利用いただけなくなります。サービスの中断を避けるため、可能な限り早期に最新バージョンの Ads API へ移行することを推奨します。
注: 本リリース時点で、Ads API のバージョン 7(v7)はサポート終了となり、利用できません。
詳細は、開発者フォーラムでの発表をご覧ください。

v8

本日、2020年9月20日、X Ads API のバージョン 8 を提供開始しました。これは、Tailored Audiences の新機能を導入し、ads.x.com との機能の整合性を高め、開発者向けのエクスペリエンスを改善することを目的としています。 従来バージョンと同様に、v8 への移行期間は 6 か月です。2021-03-02 をもって 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はサポート終了となり、すでに利用できません。 詳細は、デベロッパーフォーラムでの発表をご覧ください。

v6

本日、2019年8月28日、X は一貫性の向上と開発者エクスペリエンスの改善に重点を置いた Ads API v6 をリリースします。 このリリースには、Tweet を取得するための新しいエンドポイント、Promoted Accounts の統計情報、エンティティを名称で検索できる機能、非同期アナリティクスジョブの現在の処理数に関する情報が含まれます。さらに、メディアを利用するエンドポイントとターゲティング条件のエンドポイントに、一貫性を重視した更新を行いました。最後に、いくつかのパラメータ名とレスポンス属性を小幅に更新し、Scoped Timeline エンドポイントを非推奨とします。 詳細は、開発者フォーラムでの告知をご覧ください。

v5

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

新規

どのエンティティがアクティブだったかの判定 Active Entities エンドポイントは、広告エンティティのアナリティクス指標に変更があったかどうかを示します。アナリティクス系エンドポイントと併用するために設計されており、エンティティタイプと日付範囲(最大 90 日)を指定すると、アナリティクスをリクエストすべきエンティティの ID の配列を返します。返却された ID 以外は、後続のアナリティクスリクエストでクエリしないでください。 このエンドポイントは次のエンティティタイプをサポートします: CAMPAIGNFUNDING_INSTRUMENTLINE_ITEMMEDIA_CREATIVEPROMOTED_TWEET MEDIA_CREATIVE の指標 Ads API のアナリティクスエンドポイントで、Media Creative エンティティの指標が提供されるようになりました。Media Creative は、X Audience Platform 上のインストリーム広告や画像をプロモーションする手段です。X Ads の UI では、「In-stream videos」と「Display creatives」タブに Media Creative の指標が表示されます。同期非同期 の両アナリティクスエンドポイントが、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 ターゲティング Ads API で、Network Activation Duration ターゲティングを追加した後、レスポンス内のターゲティングタイプに _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 は無視されていました。この変更により、その関係が明確になります。

削除項目

Ads API のレスポンスから 3 つの fields が削除されます: preview_url、account_id、および parent_ids。これら 3 つに必要なエンジニアリング作業量は最小限です。
  • v4 では、cards のレスポンスパラメータ preview_url が常に null であると告知しました。この移行の最終段階として、すべての cards レスポンスから preview_url を削除します。
  • 次のリソースについては、ads アカウント ID が URL および request.params に既に含まれているため、account_id レスポンス属性を削除します。(この一覧から funding instruments を意図的に除外しています。可能な限りレスポンスオブジェクトに親 ID が含まれるべきであり、アカウント ID は funding instruments の親エンティティであるためです。)
    • Account media
    • App event providers
    • App event tags
    • Campaigns
    • Cards
    • Line items
    • Promotable users
    • Targeting criteria
  • GET accounts/:account_id/targeting_criteria リクエストについては、parent_ids field は常に空配列であったため、返さなくなります。
Non-media app cards v5 では、non-media app cards はサポートされません。 以前 は、non-media app cards を作成または編集する機能が削除されていました。今回、このリソースの残りのエンドポイントが廃止予定となります。
  • 注意: これは画像および動画の app download cards には影響しません。
Account media の作成 v5 では、POST accounts/:account_id/account_media エンドポイントは利用できません。このリソースのその他のエンドポイントには影響はありません。この変更の理由は、Media Library にメディアを追加する際、それらのアセットが自動的に Account Media エンティティとして追加される場合があり、既存のアセットを Account Media リソースに追加しようとするとエラーになるためです。これは次の場合に発生します。
  • Media Library に追加された AMPLIFY_VIDEO アセットは、クリエイティブタイプ PREROLL で自動的に Account Media アセットとして追加されます。
  • 特定の寸法の画像を Media Library に追加すると、自動的に Account Media アセットとして追加されます。クリエイティブタイプ(例: INTERSTITIAL)は画像の寸法に依存します。(寸法については、Enumerations ページを参照してください。)

v4

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

新規

Audience API(オーディエンス API) 新しい Audiences API は、堅牢性と信頼性が強化された新しいオーディエンス処理バックエンド上に構築されています。この新しいエンドポイントにより、パートナーは単一のユーザーに対して複数のユーザー識別子タイプを提供でき、マッチングに追加のシグナルを活用できます。新しい Audience エンドポイントのリファレンスドキュメントはこちらをご参照ください。年内を通じて、このプロダクトのアップデートと改善を継続的にリリースしていく予定です。 以下のエンドポイントは、機能が重複しているため 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 エンドポイントのリクエストおよびレスポンスから list_type パラメータが削除されます。 Settings Endpoints(設定エンドポイント) アカウント管理者がユーザー設定、アカウント設定、税務設定を設定および更新できるようになりました。ユーザー設定は、指定した広告アカウントにおけるユーザー固有の連絡先に関する設定を指します。PUT accounts/:account_id エンドポイントを使用すると、広告主はアカウント名と業種を更新できます。最後に、税務設定エンドポイントにより、付加価値税(VAT)の課税対象国にいる広告主は、会社名、住所、VAT ID、アカウントが広告主本人の所有か、広告主に代わって広告を行う代理店の所有かといった情報を更新できます。

変更点

Universal Lookalike の名称変更 POST accounts/:account_id/line_itemsPUT accounts/:accountit/line_items/:line_item_id エンドポイントの lookalike_expansion パラメータにおける列挙値を更新します。
v3v4
NARROWDEFINED
BALANCEDEXPANDED
すべての箇所で country_code を使用 Ads API の一貫性向上の一環として、以下のエンドポイントでパラメータ名を 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”

削除

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

v3

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

その他の変更点

これらの新機能に加えて、バージョン3には以下の変更を含めています。 新規
  • GET insights/keywords/search エンドポイントのレスポンスに、入力したキーワードに関連する 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 のプレビューを生成できる機能が含まれます。

v2

Ads API のバージョン 2 は 2017 年 7 月 10 日にリリースされました。Ads API のバージョン 1 は 2018 年 1 月 10 日にサポート終了となります。 破壊的変更/非推奨
  • total_count はレスポンス属性としてオプションになりました。with_total_counttrue に設定されている場合にのみ提供されます
  • line_items および campaigns のリクエスト/レスポンスオブジェクトにおける pauseddraft_only の fields は、単一の entity_status パラメータに置き換えられました
  • POST accounts/:account_id/tweetGET accounts/:account_id/tweet/preview エンドポイントでは、status パラメータは text に名称変更されました
  • GET targeting_criteria/locations エンドポイントの location_type の列挙値は複数形になりました。COUNTRYCOUNTRIESREGIONREGIONS などです。唯一の例外として、v2 では CITYMETROS になり、ロケーションタイプが DMA(Designated Market Areas)または「metros」を指すことを正しく反映しています
  • PUT accounts/:account_id/promoted_tweets エンドポイントの display_properties。この値はレスポンスとしても返されなくなります
  • その結果、promoted_tweets エンティティを更新(PUT)することはできなくなりました
  • GET accounts/:account_id/promoted_tweets エンドポイントの line_item_id パラメータは削除されました
  • v2 エンドポイントでは 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 を使用してください
  • すべての新しいカード形式は API でネイティブに利用可能になり、card_uri パラメータを活用できます。
新しいカード形式: 下書きキャンペーン 下書きキャンペーンは、GET accounts/:account_id/camapaigns エンドポイントで参照可能でした。v2 では、API を通じて下書きキャンペーンの作成および有効化が可能になりました。
ドラフトキャンペーンドラフトラインアイテム
funding_instrument_idcampaign_id
nameobjective
start_timeproduct_type
placements
注記
  • ドラフトのラインアイテムまたはキャンペーンは、entity_statusDRAFT から PAUSED または ACTIVE にのみ変更できます。
  • 複数のラインアイテムを含むキャンペーン全体を有効化するには、配下の各ラインアイテムとキャンペーン自体の entity_status をいずれも ACTIVE に設定する必要があります。
  • 任意のキャンペーンまたはラインアイテムの entity_status を変更するには、対応する PUT エンドポイントを使用してください。
Scheduled Tweets

v1

Ads API のバージョン 1 は 2016 年 3 月 31 日にリリースされ、2018 年 1 月 10 日にサポート終了となります。 バージョン 1 の変更点:
  • バージョン管理のサポート
  • CUSTOM objective はサポート終了となりました
  • バッチエンドポイント が一般提供されました
  • リーチ推定の変更点:
  • より正確なリーチ推定のために、エンドポイントは予算を考慮するようになりました。次のパラメータが必須になりました:
    • [new] campaign_daily_budget_amount_local_micro
    • currency
    • bid
    • objective
  • レスポンスオブジェクトが変更され、レスポンス値の範囲を返すようになりました。
  • infinite_count は、その目的に関する混同を避けるため infinite_bid_count に名称変更されました
  • countinfinite_bid_count に加えて、次の新たなデータポイントも返されます:
    • impressions
    • engagements
    • estimated_daily_spend_local_micro
  • テーラードオーディエンスのデータタイプの変更
  • Tailored Audiences の data_type は、すべてのレスポンスで tailored_audiences から tailored_audience に変更されました。
  • 共有 Tailored Audiences は現在、API 限定のベータ版として利用可能です。Shared Tailored Audiences を使用すると、1 つのオーディエンスを複数の広告アカウントで利用できます。広告アカウント間で共有したいオーディエンスの権限を管理するには、POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions(および関連)エンドポイントを使用してください。
  • 広告主アカウントのパフォーマンスアナリティクスの収集方法が大幅に改善されました:
  • 当社のベストプラクティスベストプラクティスに沿い、同期統計エンドポイント同期統計エンドポイントで取得可能なデータは最大7日間分に限定します。
  • メトリクスの取得を簡素化するため、metrics パラメータを新しい metric_groups パラメータに置き換えました。開発者は、特定のリクエストについて返却を希望するメトリクスのグループを指定する必要があります。
    • 特定のエンティティに適さないメトリクスのリクエストは、レスポンスから除外され、null 値として返されます。 これらのメトリクスはアナリティクスのコスト上限には計上されません。
  • レスポンスは大幅に簡素化され、今後は当社のUIにおけるメトリクスの表示方式により近い形で整合するようになります。
    • これまでは各掲載場所(検索の Promoted Tweets、タイムラインの Promoted Tweets、プロフィールとツイート詳細の Promoted Tweets、X Audience Platform)ごとに個別の指標を公開していました。今後は、それぞれについて標準化された指標セットを返します。つまり、promoted_tweet_timeline_impressionspromoted_tweet_search_impressionspromoted_tweets_profile_impressionspromoted_tweets_tpn_impressions の代わりに、以下のいずれかのカテゴリでリクエストされた場合は単一の指標 impressions として提供します(これはすべての指標に適用されます)。
    • ALL_ON_TWITTER
    • PUBLISHER_NETWORK
    • リクエスト時には、UI 上の値と照合しやすくするため、単一の impressions 指標が返されます。
    • ALL_ON_TWITTERPUBLISHER_NETWORK の両方のデータを取得するには、これらは結合できないため、2 回のクエリを実行する必要があります。
  • 非同期の統計エンドポイントが、開発者の皆さまからのフィードバックを受けて提供開始されました!
    • すぐに必要ではないデータや過去データ取得のために、統計を非同期でリクエストできる新しいエンドポイント群。
    • 新しい単一のエンドポイントで統計ジョブをキューに投入できます。リソース状況に応じて、リクエストされたデータを取得します。
    • データの利用可否は、ジョブステータス用エンドポイントで確認できます。
    • データが利用可能になったら、同期エンドポイントと同等のJSONレスポンスをダウンロードできるよう、受け取り用のIDを提供します。
    • 1つのジョブで、最大90日分のデータを、最大20エンティティまでクエリできます。
  • v0のメトリクスをv1のメトリクスに対応付けたマッピングを含む、analytics v1移行ガイドをご覧ください
  • Sandbox の改善点 * Sandbox 環境で複数のテスト広告アカウントを作成できるようになりました。 * Sandbox 環境に限り、テスト広告アカウント向けに複数の資金管理手段を作成できるようになりました。これにより、すべての資金管理手段タイプでテストできます。以前はテストに使用できる資金ソースは CREDIT_CARD のみでした。 * ベータ機能をテストしたいですか?あなたのテストのニーズに合わせて、Sandbox 環境でアカウントの機能をオン/オフで切り替えられるようになりました。

v0

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