Twitter Ads APIにバージョン指定機能を追加します

投稿者 ‎@jaakkosf‎
木曜日, 2016年2月25日

Twitterの提供する広告APIでは、毎月新しい機能を追加しています。これらは後方互換性のある機能ですが、新しい変更を毎年行っています。この変更の頻度や、開発に掛かる工数に関して、常に皆さんからのフィードバックをいただいてきました。皆さんから頂戴したご意見をもとに、今期の後半から広告APIが開発者の方に提供してきたエクスペリエンスをより良くしていきます。

変更点

挙動に変更が発生する場合に、APIのバージョンをあげます。開発者の方には聞き覚えのあるバージョニングですが、Twitterはセマンテック バージョニングを導入していきます。これにより、開発者の方にはより簡単で、明確に何がいつ変わって、変更を導入するためのプランニングができるようになります。Twitterのバージョニングはメジャーとマイナー両方の変更を表示します。たとえば、2.3. 動作に障害が発生する、あるいは後方互換性のない、または重要なすべての変更点はメジャーバージョンを上げ、後方互換性のある変更点はマイナーバージョンを上げます。

一例:

  • 現状の広告APIバージョン2.0に対し、promotable_userに新たな属性として表示されるTwitter screen_nameを追加した場合、こちらは後方互換としてバージョンを2.1に上げます
  • user_id属性を同じオブジェクトから除外する変更を実施した場合、後方互換性のない変更となり、メジャーバージョンを上げる事となりますのでバージョンは3.0となります。

広告APIに対し、現状の30日間の事前告知から、新しいバージョンがリリースされてから最低でも90日間サポートに移行します。

広告APIにある数多くの変更の中で、すべてのバージョンは後方互換性のあるものであるため、開発者は任意のメジャーバージョンのみリクエストするだけで結構です。開発者の方がマイナーバージョン間での変更を把握できるようにするため、Twitterはdev.twitter.comにある仕様書に現状のメジャー.マイナーをレスポンスのヘッダーに戻し、変更ログを追加します。

  • 引き続き開発者はリクエストしたリソースURLの中で指定するAPIのバージョンを引き渡します
  • TwitterはAPIレスポンスに対し新しいヘッダーを返します: x-api-version: 1.1
  • すべてのAPIコールは引き続きバージョンを特定する必要があります

TwitterはTwitter広告プラットフォームを活用して開発者の皆さんがつくり上げていくソリューションを見るのを楽しみにしています!そのために、広告APIを通じて皆さんをより良くサポートしていきたいと考えていますので、今後とも広告APIプログラムをよろしくお願いいたします。