ディスプレイ広告 API v3 リリースノート

リリースバージョン

v3

リリース日

2020年10月20日(火)

本リリースの主な内容

※オブジェクトなどの詳細は、リファレンスをご確認ください。

1. 顧客データのインポート機能に対応

お客様が保有している顧客データをインポートし、カスタムリストとして広告配信での利用が可能となりました。機能の詳細は以下を参照してください。
【ディスプレイ広告】データインポート機能追加のお知らせ

対象サービス
RetargetingListService
・uploadUserListを追加
・getUploadUserListStatusを追加

2. 「コンバージョン経路レポート」「横断リーチレポート」の提供

「横断リーチレポート」「コンバージョン経路レポート」を出力できるようになりました。機能の詳細は以下を参照してください。
【ディスプレイ広告】新たなレポートの提供開始について

対象サービス
ReportDefinitionService
・ReportDefinitionServiceTypeに以下を追加
 - CONVERSION_PATH
 - CROSS_CAMPAIGN_REACHES

・ReportDefinitionにreportTypeConditionを追加

3. サイトジェネラルタグの新しいフォーマットに対応

広告管理ツールで提供している新しいフォーマットのサイトジェネラルタグを取得できるようになりました。

対象サービス
・ConversionTrackerService
 addでWEB_CONVERSIONを追加時、またはgetでWEB_CONVERSIONを取得時、レスポンスにadvancedTagを追加します。

・RetargetingTagService
 add、getのレスポンスにadvancedTagを追加します。

4. システムの保守、改善

以下の変更を実施しました。

・AccountService
 リクエストとレスポンスからbudgetを削除し、アカウント予算の取得、更新を停止

・AdGroupAdService
 - dynamicAdに以下を追加し、brandColor、prefix、suffixの値の削除に対応。
  isRemoveBrandColor
  isRemovePrefix
  isRemoveSuffix

 - 以下の項目を追加し、広告の作成日付による絞り込み検索に対応
  AdGroupAdServiceSelectorにcreatedDateRangeを追加
  AdGroupAdにcreatedDateを追加

・AdGroupService
 以下の項目を追加し、広告グループの作成日付による絞り込み検索に対応
 AdGroupServiceSelectorにcreatedDateRangeを追加
 AdGroupにcreatedDateを追加

・BudgetOrderService
 アカウント予算の取得、更新を行う新サービスとして追加

・CampaignService
 以下の項目を追加し、キャンペーンの作成日付による絞り込み検索に対応
 CampaignServiceSelectorにcreatedDateRangeを追加
 CampaignにcreatedDateを追加

・DictionaryService
 DictionaryServiceMediaAdFormatのgetレスポンスに予約型の広告用のMediaAdFormatかを示すrichFormatを追加

・MediaService
 - MediaServiceRecordのgetレスポンスに予約型広告の画像かを示すmediaRichFormatFlgを追加

 - 以下の項目を追加し、画像の作成日付による絞り込み検索に対応
  MediaServiceSelectorにcreatedDateRangeを追加
  MediaServiceRecordにcreatedDateを追加

・ReportDefinitionService
 frequencyRangeを廃止し、リーチレポートおよびフリークエンシーレポートの作成をreportTypeConditionでの指定に変更

・VideoService
 以下の項目を追加し、動画の作成日付による絞り込み検索に対応
 VideoServiceSelectorにcreatedDateRangeを追加
 VideoにcreatedDateを追加

5. システムの保守、改善(後日追加)

追加の保守、改善を、以下の各日程で実施します。

・実施予定日:
2020年11月25日(水)
※日程は変更になる場合があります。

AdGroupAdService
・全アクションのdisapprovalReasonCodesを従来の10件から30件に増加。審査否認時の否認理由を広告で最大30件まで取得でき、再審査依頼などで参照が可能に。

・実施予定日:
2020年11月26日(木)
※日程は変更になる場合があります。

DictionaryService
・ディスプレイ広告(予約型)のMediaAdFormatについて、フォーマットの新規追加と値の修正を実施
- 新規追加
YJ_1350_760
YJ_450_150
-アスペクト比の修正
YJ_170_1024: aspectRatioを、AR_170_1024からAR_85_512に変更
YJ_450_50: aspectRatioを、AR_450_50からAR_9_1に変更
※ディスプレイ広告(予約型)は一部のお客様にのみ提供しています。
※ディスプレイ広告(運用型)のMediaAdFormatは変更ありません。

ディスプレイ広告 API 旧バージョンの提供終了について

旧バージョンの提供を、以下の日程で終了します。

v1
サポート終了日:2020年11月30日(月)
システム終了日:2021年3月22日(月)

v0
・システム終了日:2020年11月19日(木)
※サポートは終了済みです。

なお、YDN API(SOAP版)のV201907およびV201911は、2020年12月16日にシステム終了予定です。