Yahoo!広告 API | Developer Center
Englishディスプレイ広告 API v2 リリースノート
リリースバージョン
v2リリース日
2020年7月20日（月）本リリースの主な内容
※オブジェクトなどの詳細は、リファレンスをご確認ください。1.月額課金の予算変更に対応
月額課金の予算変更に対応しました。月額予算は、accountTypeがINVOICEの場合のみ変更可能です。 また、予算額は1000円単位で指定する必要があります。
対象サービス
AccountService
- budget項目の指定による月額予算の変更に対応
- エラーコード(210004)の追加
2. 認可したビジネスIDの取得に対応
アプリケーションに対してYahoo!広告へのアクセスを認可したYahoo! JAPANビジネスIDの取得に対応しました。対象サービス
AccountServicese
AccountServicePageオブジェクトに、authorizationBusinessId項目を追加
3.AccountAuthorityServiceの追加
ディスプレイ広告のアカウント権限を操作するAccountAuthorityServiceを新たに追加しました。また、これまでアカウント権限の取得が可能だったAccountServiceのaccountAuthoritiesフィールドは廃止されます。
対象サービス
・AccountAuthorityService
新規サービスとして追加
・AccountService
Accountオブジェクトから、accountAuthorities項目を削除
4.パフォーマンスレポートの「年齢」項目の一部範囲を変更
パフォーマンスレポート作成時に「年齢」を指定した場合、これまで「～5歳」と「6歳～12歳」の範囲に分けて集計していましたが、v2以降は「～12歳」にまとめて集計します。※以前のバージョンでは、これまで通り「～5歳」と「6歳～12歳」の範囲に分けて集計されます。
対象サービス
ReportDefinitionService
5. ビュースルーコンバージョンの追加
新たな効果測定数値としてビュースルーコンバージョン（viewThroughConversions）を追加しました。詳細は以下のお知らせを参照してください。なお数値を取得できるのは、本件の実施日以降となります。
【ディスプレイ広告】統計項目「ビュースルーコンバージョン」の追加について
対象サービス
・ConvertionTrackerService
ConversionTrackerServiceValueオブジェクトにviewThroughConversionsを追加
・StatsService
以下のオブジェクトにviewThroughConversionsを追加
- StatsServiceAdGroupStatsValue
- StatsServiceAdStatsValue
- StatsServiceCampaignStatsValue
- StatsServiceImageStatsValues
- StatsServiceTargetStatsValues
- StatsServiceVideoStatsValue
6. システムの保守、改善
以下の変更を実施しました。・AccountService
AccountServiceReturnValueのvalues項目の型を、AccountServiceValueオブジェクト型からAccountServiceValueオブジェクトの配列型に変更
・AdGroupAdService
以下のオブジェクトで、isRemoveLogoMediaIdの指定によるロゴメディア画像の解除に対応
- AdGroupAdServiceResponsiveImageAd
- AdGroupAdServiceResponsiveVideoAd
- AdGroupAdServiceStaticFrameAd
・AdGroupService
- 広告グループへの商品セットの紐付けが必須化されたため、AdGroupServiceValueオブジェクトのisRemoveFeedSetId項目を削除
- 入札方法の種類を示す「AdGroupServiceType」を、適切なEnum名「AdGroupServiceBidType」に変更
・DictionaryService
サービスのHTTPメソッドを統一するため、getMediaAdFormatとgetThirdPartyTrackingDomainのHTTPメソッドをGETからPOSTに変更
・PlacementUrlListService
PlacementUrlListオブジェクトにisRemoveDescriptionを追加し、Setリクエストによる「説明」の削除に対応
・ReportDefinitionService
検索広告 APIと統一するため、ReportDefinitionオブジェクトで以下の項目を追加
- 「reportDownloadFormat」項目に「TSV」追加
- 「reportDownloadEncode」項目に「UTF16LE」を追加
同様に、以下の項目名を変更
| 変更前 | 変更後 |
|---|---|
| compressType | reportCompressType |
| dateRangeType | reportDateRangeType |
| downloadEncode | reportDownloadEncode |
| downloadFormat | reportDownloadFormat |
| jobStatus | reportJobStatus |
| Lang | reportLanguage |
| Zip | reportCompressType |
また、「reportJobStatus」項目で返却される値「ACCEPTED」を「WAIT」に変更
- 今後の機能追加のため、ReportDefinitionオブジェクトのdateRangeType項目に「通期」を追加
※「通期」の指定は、ディスプレイ広告（予約型）のキャンペーンのレポートを取得する場合のみ指定可能
・RetargetingListService
RetargetingListオブジェクトにisRemoveDescriptionを追加し、Setリクエストによる「説明」の削除に対応
・SearchKeywordListService
SearchKeywordListオブジェクトにisRemoveSearchKeywordListDescriptionを追加し、Setリクエストによる「説明」の削除に対応
ディスプレイ広告 API v0の提供終了について
以下の日程でディスプレイ広告 API v0のサポート、およびシステムの提供を終了いたします。・サポート終了日：2020年8月31日（月）
・システム終了日：2020年11月19日（木）
なお、YDN API（SOAP版）のV201911は2020年6月30日にサポートを終了しています。
また、V201907およびV201911は、2020年12月16日にシステム終了予定です。