| バージョン | パス | 導入日 | 非推奨日 | サポート終了日 |
|---|---|---|---|---|
| 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日 |
概要
- API のリクエスト/レスポンスからパラメータを削除する
- パラメータ名またはエンドポイント名を変更する
- 値の表現方法の変更(preview_url → card_uri)
- エンドポイントの動作変更(例: 非同期と同期の統計)
- 任意または必須パラメータの追加/変更(例: リクエストで name を必須フィールドにする)
バージョニング戦略
- すべての非互換(破壊的)変更は新しいバージョンにまとめて提供します
- 新しいバージョンの告知時点から、既存バージョンの非推奨期間は6か月とします
- いずれの時点でも、APIは同時に2つのバージョンからのリクエストを受け付けますが、古い方のバージョンはサポート対象外となります
- 新製品の採用を迅速化するため、これらは継続的に(バージョニングの定期サイクル外で)リリースします
-
すべてのAPIレスポンスには
x-current-api-versionが含まれ、現在のAPIバージョンが設定されます。さらに、非推奨のAPIエンドポイントを呼び出した場合はx-api-warnヘッダーが付与されます。
v9
注: 本リリース時点で、Ads API のバージョン 7(v7)はサポート終了となり、利用できません。
v8
v7
v6
v5
accounts/:account_id/account_media エンドポイントは非推奨となりました。
これまでのバージョンと同様に、v5 への移行期間は 6 か月です。2019-08-28 以降、Ads API のバージョン 4 は利用できなくなります。サービス中断を回避するため、すべてのパートナーに対し、可能な限り速やかに最新バージョンの API へ移行することを推奨します。Ads API のバージョン 3 はサポート終了に達しており、すでに利用できません。
新規
CAMPAIGN、FUNDING_INSTRUMENT、LINE_ITEM、MEDIA_CREATIVE、PROMOTED_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 つです。
- URL パスは
accounts/:account_id/cards/allになりました。(以前のパスは利用できません。)これは、ID でカードを取得するように設計されたエンドポイントとの一貫性を保つためです。 - 必須のリクエストパラメータ名は card_uris(複数形)になりました。
- GET accounts/:account_id/line_item_apps
- GET accounts/:account_id/media_creatives
- GET accounts/:account_id/promoted_accounts
- GET accounts/:account_id/preroll_call_to_actions
変更点
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 は無視されていました。この変更により、その関係が明確になります。
削除項目
- 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 は常に空配列であったため、返さなくなります。
- 注意: これは画像および動画の app download cards には影響しません。
- Media Library に追加された
AMPLIFY_VIDEOアセットは、クリエイティブタイプPREROLLで自動的に Account Media アセットとして追加されます。 - 特定の寸法の画像を Media Library に追加すると、自動的に Account Media アセットとして追加されます。クリエイティブタイプ(例:
INTERSTITIAL)は画像の寸法に依存します。(寸法については、Enumerations ページを参照してください。)
v4
新規
- 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
list_type パラメータが削除されます。
Settings Endpoints(設定エンドポイント)
アカウント管理者がユーザー設定、アカウント設定、税務設定を設定および更新できるようになりました。ユーザー設定は、指定した広告アカウントにおけるユーザー固有の連絡先に関する設定を指します。PUT accounts/:account_id エンドポイントを使用すると、広告主はアカウント名と業種を更新できます。最後に、税務設定エンドポイントにより、付加価値税(VAT)の課税対象国にいる広告主は、会社名、住所、VAT ID、アカウントが広告主本人の所有か、広告主に代わって広告を行う代理店の所有かといった情報を更新できます。
変更点
lookalike_expansion パラメータにおける列挙値を更新します。
| v3 | v4 |
|---|---|
NARROW | DEFINED |
BALANCED | EXPANDED |
country_code を使用
Ads API の一貫性向上の一環として、以下のエンドポイントでパラメータ名を app_country_code から country_code に変更します。
- POST accounts/:account_id/cards/image_app_download
- PUT accounts/:account_id/cards/image_app_download/:card_id
- POST accounts/:account_id/cards/video_app_download
- PUT accounts/:account_id/cards/video_app_download/:card_id
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"
as_user_id
GET accounts/:account_id/tweet/preview/:tweet_id エンドポイントで利用可能だった as_user_id パラメータは今後受け付けられません。プレビューは常に Tweet の投稿者としてレンダリングされます。
v3
- 入力オーディエンスを指定して、関連性の高い上位のハッシュタグ、@ハンドル、イベントを取得します。
- 入力オーディエンスを指定して、主要な人口統計情報(年齢、性別、世帯収入など)を取得します。
- キーワードを指定して、Tweet のボリュームの時系列データを取得します。
その他の変更点
- 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 のアスペクト比への切り替えを推奨します。
- PUT accounts/:account_id/targeting_criteria エンドポイントは利用できなくなりました。この変更は、当該エンドポイントの置換動作が広告主の混乱を招き、また、1 回に 1 つのリソースを更新する他の PUT エンドポイントとの整合性が取れていなかったために行いました。代わりに、POST batch/accounts/:account_id/targeting_criteria エンドポイントを使用してください。こちらは、1 回のリクエストでターゲティングの追加と削除の両方が可能になるなど、より高い柔軟性を提供します。
- funding instrument については、レスポンス属性 paused は返されなくなりました。代わりに、funding instrument が一時停止状態かどうかを判断するには、レスポンス属性 entity_status を参照してください。加えて、paused と cancelled は同一の値に対応しているため、レスポンスで cancelled も返されなくなりました。
- GET accounts/:account_id/tweet/preview エンドポイントから card_id パラメータを削除しました。
- 削除済みの Scheduled Tweets は取得できないため、with_deleted パラメータはサポートされなくなりました。
- 次のエンドポイントから draft_only パラメータを削除しました。これらのエンティティはドラフト状態になることがないためです。
v2
-
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 エンドポイントでは、
statusパラメータはtextに名称変更されました -
GET targeting_criteria/locations エンドポイントの
location_typeの列挙値は複数形になりました。COUNTRYはCOUNTRIES、REGIONはREGIONSなどです。唯一の例外として、v2 ではCITYがMETROSになり、ロケーションタイプが 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レスポンス属性は返されなくなりました
- Cards v2
- 下書きキャンペーン/ラインアイテムの作成と有効化
- 予約投稿(Scheduled Tweets)
- 非同期ジョブのサマリー
- カードを Tweet と関連付ける際は、Tweet テキストに
preview_urlを付加するのではなく、card_uriリクエストパラメータを使用してください - カード作成時のレスポンスで
card_uriパラメータが返されない場合は、代わりにpreview_urlを使用してください - すべての新しいカード形式は API でネイティブに利用可能になり、
card_uriパラメータを活用できます。
- Video Website Cards:
- POST accounts/:account_id/line_items および POST accounts/:account_id/campaigns エンドポイントの
entity_statusパラメータをDRAFTに設定すると、新規のドラフトキャンペーンまたはラインアイテムを作成できます。 - 新規作成したドラフトに必須のパラメータ:
| ドラフトキャンペーン | ドラフトラインアイテム |
|---|---|
funding_instrument_id | campaign_id |
name | objective |
start_time | product_type |
placements |
- ドラフトのラインアイテムまたはキャンペーンは、
entity_statusをDRAFTからPAUSEDまたはACTIVEにのみ変更できます。 - 複数のラインアイテムを含むキャンペーン全体を有効化するには、配下の各ラインアイテムとキャンペーン自体の
entity_statusをいずれもACTIVEに設定する必要があります。 - 任意のキャンペーンまたはラインアイテムの
entity_statusを変更するには、対応する PUT エンドポイントを使用してください。
- Scheduled Tweets は以下の新しいエンドポイントで構成されます
- Scheduled Tweets:
- Campaign Management:
- 新規にスケジュールされた Tweet は、将来の任意の日付に設定できます。
- 現時点では、スケジュールされた Tweet をプレビューする機能はありません。
-
SCHEDULED状態の Scheduled Tweets のみ編集・削除できます。 -
Scheduled Tweets は、
scheduled_atの日時まではエンタープライズ Firehose やその他の data API に伝播されません(強調:not)。
v1
- バージョン管理のサポート
CUSTOMobjective はサポート終了となりました- バッチエンドポイント が一般提供されました
- リーチ推定の変更点:
- より正確なリーチ推定のために、エンドポイントは予算を考慮するようになりました。次のパラメータが必須になりました:
- [new]
campaign_daily_budget_amount_local_micro currencybidobjective
- [new]
- レスポンスオブジェクトが変更され、レスポンス値の範囲を返すようになりました。
infinite_countは、その目的に関する混同を避けるためinfinite_bid_countに名称変更されましたcountとinfinite_bid_countに加えて、次の新たなデータポイントも返されます:impressionsengagementsestimated_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_impressions、promoted_tweet_search_impressions、promoted_tweets_profile_impressions、promoted_tweets_tpn_impressionsの代わりに、以下のいずれかのカテゴリでリクエストされた場合は単一の指標impressionsとして提供します(これはすべての指標に適用されます)。 ALL_ON_TWITTERPUBLISHER_NETWORK- リクエスト時には、UI 上の値と照合しやすくするため、単一の
impressions指標が返されます。 ALL_ON_TWITTERとPUBLISHER_NETWORKの両方のデータを取得するには、これらは結合できないため、2 回のクエリを実行する必要があります。
- これまでは各掲載場所(検索の Promoted Tweets、タイムラインの Promoted Tweets、プロフィールとツイート詳細の Promoted Tweets、X Audience Platform)ごとに個別の指標を公開していました。今後は、それぞれについて標準化された指標セットを返します。つまり、
- 非同期の統計エンドポイントが、開発者の皆さまからのフィードバックを受けて提供開始されました!
- すぐに必要ではないデータや過去データ取得のために、統計を非同期でリクエストできる新しいエンドポイント群。
- 新しい単一のエンドポイントで統計ジョブをキューに投入できます。リソース状況に応じて、リクエストされたデータを取得します。
- データの利用可否は、ジョブステータス用エンドポイントで確認できます。
- データが利用可能になったら、同期エンドポイントと同等のJSONレスポンスをダウンロードできるよう、受け取り用のIDを提供します。
- 1つのジョブで、最大90日分のデータを、最大20エンティティまでクエリできます。
- v0のメトリクスをv1のメトリクスに対応付けたマッピングを含む、analytics v1移行ガイドをご覧ください
- Sandbox の改善点 * Sandbox 環境で複数のテスト広告アカウントを作成できるようになりました。 * Sandbox 環境に限り、テスト広告アカウント向けに複数の資金管理手段を作成できるようになりました。これにより、すべての資金管理手段タイプでテストできます。以前はテストに使用できる資金ソースは
CREDIT_CARDのみでした。 * ベータ機能をテストしたいですか?あなたのテストのニーズに合わせて、Sandbox 環境でアカウントの機能をオン/オフで切り替えられるようになりました。