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

リリースバージョン

v7

リリース日

2022年1月17日(月)

本リリースの主な内容

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

1. 入札戦略の名称変更

入札戦略に関する名称を変更しました。

 対象サービス
 ・CampaignService
 ・AdGroupService
 ・GuaranteedCampaignService
 ・GuaranteedInventoryService
 ・GuaranteedReservationService
 ・RecommendationService

 内容
 ・対象サービスにおいて、以下のENUMの名称を変更しました。
 
変更前変更後
MAX_CPC CPC
MAX_CPV CPV
MAX_VCPM VCPM
MAXIMIZE_VIEW MAXIMIZE_VIDEO_VIEWS
MAXIMIZE_VIEABLEIMPRESSIONS MAXIMIZE_VIEWABLE_IMPRESSIONS


 ・対象サービスにおいて、以下のフィールドの名称を変更しました。
 
変更前変更後
maxCpcBidValue cpcBidValue
maxCpvBidValue cpvBidValue
maxVcpmBidValue vcpmBidValue
currentMaxCpcBidValue currentCpcBidValue

2. 掲載期間の時間指定対応

キャンペーンで設定する掲載期間について、従来の年月日単位に加え、時・分単位の指定が可能になりました。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
 【ディスプレイ広告】キャンペーンの掲載期間への時間指定追加について

 対象サービス
 ・CampaignService
 ・GuaranteedCampaignService
 ・GuaranteedSimulationService
 ・GuaranteedInventoryService

 内容
 ・対象サービスに以下のフィールドを追加しました。
  campaign/startTime
  campaign/endTime
  guaranteedSimulation/startTime
  guaranteedSimulation/endTime
  guaranteedInventory/startTime
  guaranteedInventory/endTime

3. キャンペーン目的、キャンペーン掲載タイプの追加(全バージョン)

キャンペーン目的と掲載タイプを追加しました。v5、v6ではすでに提供中の機能です。
※この機能は一部のお客様のみご利用になれます。詳細は以下を参照してください。
 Yahoo!セールスプロモーション

 対象サービス
 ・CampaignService
 ・ReportDefinitionService
 ・AccountAuthorityService

 内容
 対象サービスに以下のキャンペーン目的とキャンペーン掲載タイプを追加しました。

 ・キャンペーン目的
  PayPayギフト(PAYPAY_GIFT)
 ・キャンペーン掲載タイプ
  セールスプロモーション(SALES_PROMOTION)

4. オーディエンス管理機能に対応

クライアントデータやYahoo! JAPANの持つオーディエンスデータを活用するためのオーディエンス管理機能に対応しました。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
 【ディスプレイ広告】オーディエンス管理機能の提供開始について

これに伴い、RetargetingListServiceの名称をAudienceListServiceに変更しました。その他の変更は以下のとおりです。

 対象サービス
 ・AccountLinkService
 ・AdGroupTargetService
 ・AudienceListService
 ・GuaranteedInventoryService
 ・GuaranteedSimulationService
 ・ReportDefinitionService
 ・StatsService

 内容
 AudienceListService
  以下のオーディエンスリスト種別の指定が可能になりました。
  - サイト訪問ユーザー(WEBSITE_VISITORS)
  - 顧客データ(CUSTOMER_DATA)

 AccountLinkService
 以下のフィールドの名称を変更しました。
 
変更前変更後
retargetingListSharingEnabled audienceListSharingEnabled


 AdGroupTargetService
 GuaranteedInventoryService
 GuaranteedSimulationService
 StatsService
 ・以下のフィールドの名称を変更しました。
  
変更前変更後
targetListDeliverType deliverType
targetListName audienceListName
siteRetargetingTarget audienceListTarget

 ・targetTypeで指定できるEnumから、以下の名称を変更しました。
  
変更前変更後
SITE_RETARGETING AUDIENCE_LIST_TARGET


 ReportDefinitionService
 targetTypeで指定できるEnumから、以下の名称を変更しました。
  
変更前変更後
SITE_RETARGETING AUDIENCE_LIST_TARGET


5. フルHDサイズ、HDサイズの動画に対応

広告に掲載する動画について、フルHDサイズ、HDサイズの操作に対応しました。

 対象サービス
 VideoService

 内容
 ・VideoService/getで、フルHDサイズ、HDサイズの動画のダウンロードが可能かを見分ける以下のフィールドを追加しました。
  video/videoSetting/extraSpecs[]
  video/videoSetting/extraSpecs[].qualityType
   FULLHD
   HD

 ・VideoService/downloadのqualityTypeフィールドで、フルHDサイズ、HDサイズの動画が指定可能になりました。

6. ターゲティングの配信設定参照に対応

ディスプレイ広告 APIから、各種ターゲティング設定のオンオフについて参照可能になりました。
※広告管理ツールでは以前から提供している機能です。

 対象サービス
 AdGroupTargetService

 内容
 全てのターゲティングについて、配信設定を表すフィールド「targetSetting」を追加しました。

7. コンバージョン経路レポート、横断リーチレポートの改善

コンバージョン経路レポートで、広告グループ単位での経路表示に対応しました。また、一部レポート項目の名称変更と追加を実施します。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
 【ディスプレイ広告】コンバージョン経路および横断リーチレポートの改善

 対象サービス
 ReportDefinitionService

 内容
 ・返却するレポート項目に、以下を追加しました。
  -コンバージョン経路レポート
   CLICK_AND_VIDEO_CONVERSIONS_FOR_CONVERSION_PATH
   CLICK_CONVERSIONS_FOR_CONVERSION_PATH
   VIEW_THROUGH_CONVERSIONS_FOR_CONVERSION_PATH
   TOUCHPOINT_1_ADGROUP(~TOUCHPOINT_20_ADGROUP)
  -横断リーチレポート
   UNIQUE_USERS_WITH_VIEW_THROUGH_CONVERSIONS
   UNIQUE_USERS_WITH_CLICK_CONVERSIONS
   UNIQUE_USERS_WITH_CLICK_AND_VIDEO_CONVERSIONS

 ・conversionPathFilterTypeに、以下のENUMを追加しました。
   ADGROUP_NAME
   ADGROUP_ID

ディスプレイ広告 API v5の提供終了について

以下の日程でディスプレイ広告 API v5のサポート、およびシステムの提供を終了いたします。
・サポート終了日:2022年2月24日(木)
・システム終了日:2022年6月8日(水)

また、以前にお伝えしたとおり、ディスプレイ広告 API v4を以下の日程で終了します。
・システム終了日:2022年2月24日(木)
 ※サポートは終了済みです。