Yahoo!広告 API | Developer Center

English

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

リリースバージョン

v10

リリース日

2023年2月14日（火）

本リリースの主な内容

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

1. オーディエンスリスト（Yahoo! Audience Discovery）の提供に対応

新規リスト「オーディエンスリスト（Yahoo! Audience Discovery）」が利用できるようになりました。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のお知らせを参照してください。
ディスプレイ広告　新規オーディエンスリストの提供開始、およびオーディエンスリスト（カスタム）の提供終了について

対象サービス

AudienceListSevice
AdGroupTargetService
GuaranteedAdGroupService

内容

AudienceListSevice
‐audienceListType、sourceTypeにENUM値「YAHOO_JAPAN_AUDIENCE_DISCOVERY」を追加
‐audienceListContentにyahooJapanAudienceDiscoveryAudienceListフィールドを追加
AdGroupTargetService、GuaranteedAdGroupService
‐audienceListTypeにENUM値「YAHOO_JAPAN_AUDIENCE_DISCOVERY」を追加

2. 最適化スコアの提供に対応

自動入札がどの程度最適な運用になっているかを評価する最適化スコアの確認が可能になりました。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
【ディスプレイ広告（運用型）】最適化スコア提供開始のお知らせ

対象サービス

AccountService

内容

アカウント単位の最適化スコアを表すフィールドとしてoptimizationScoreを追加

3. 画像の高画質化機能に対応

画像登録時に画質が粗くならないように調整する高画質化機能に対応しました。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
【ディスプレイ広告】画像登録時の高画質化機能について

対象サービス

MediaService

内容

mediaRecord.imageMedia.upscaleImageEnabledを追加
初期設定は「高画質化を実施する（オン）」の状態です。なおv9以前のバージョンでは利用できないため、画像登録時に高画質化は実施されません。

4. 広告タイプの名称変更と項目追加に対応

広告の種類を表す広告タイプを、広告種別とメディア形式に分割した形に変更するため、名称変更や新しいフィールドの追加などを行いました。
※詳細は以下のお知らせを参照してください。
【ディスプレイ広告】広告タイプの名称変更と項目追加について

対象サービス

AdGroupAdService
GuaranteedAdGroupAdService
ReportDefinitionService
PlacementUrlIdeaService

内容

対象サービスごとの変更内容は以下のとおりです。

サービス名	変更内容
AdGroupAdService	adTypeを以下に変更・BANNER_AD ・CAROUSEL_AD ・DYNAMIC_DISPLAY_AD ・RESPONSIVE_AD ・TEXT_AD
	メインメディアの形式として、adTypeと並列の位置にmainMediaFormatフィールドを追加。ENUM値は以下を指定可能・NONE ・IMAGE ・VIDEO
	広告の詳細を表すクラスを統合し、以下に変更・bannerImageAdとbannerVideoAdを統合しbannerAdに変更・responsiveImageAdとresponsiveVideoAdを統合しresponsiveAdに変更・dynamicAdはdynamicDisplayAdに名称変更
	adStyleを削除
GuaranteedAdGroupAdService	adTypeを以下に変更・BANNER_AD ・CAROUSEL_AD ・INSTREAM_AD ・BRANDPANEL_QUINTIE ・BRANDPANEL_PANORAMA ・BRANDPANEL_PANORAMA_PANEL_SWITCH ・TOP_IMPACT_SQUARE ・TOP_IMPACT_QUINTIE ・TOP_IMPACT_THEATER ・TOP_IMPACT_PRIME_DISPLAY_DOUBLE ・TOP_IMPACT_PANORAMA ・TOP_IMPACT_PANORAMA_SIDE_VISION ・TOP_IMPACT_PANORAMA_SIDE_SWITCH ・TOP_IMPACT_PANORAMA_PANEL_SWITCH
	メインメディアの形式として、adTypeと並列の位置にmainMediaFormatフィールドを追加。ENUM値は以下を指定可能・IMAGE ・VIDEO
	広告の詳細を表すクラスを統合し以下に変更・bannerAd ・carouselAd ・instreamAd ・brandPanelQuintie ・brandPanelPanorama ・brandPanelPanoramaPanelSwitch ・topImpactSquare ・topImpactQuintie ・topImpactTheater ・topImpactPrimeDisplayDouble ・topImpactPanorama ・topImpactPanoramaSideVision ・topImpactPanoramaSideSwitch ・topImpactPanoramaPanelSwitch
	adStyleを削除
PlacementUrlIdeaService	メインメディアの形式として、adTypeと並列の位置にmainMediaFormatフィールドを追加。ENUM値は以下を指定可能・NONE ・IMAGE ・VIDEO
PlacementUrlIdeaService	adStyleを削除
ReportDefinitionService	新しいadTypeをレポート項目として出力可能

※AuditLogServiceでダウンロードできる操作履歴ファイルは旧形式の広告タイプで出力されます。

5. 広告グループ入札価格および目標単価に削除フラグを追加

広告グループの入札戦略に設定する最大入札価格（CPC、CPV、vCPM）および目標値（tCPA）の削除フラグを追加しました。

対象サービス

AdGroupService

内容

以下のフィールドを追加します。
cpcBiddingScheme.isRemoveCpc
cpvBiddingScheme.isRemoveCpv
vcpmBiddingScheme.isRemoveVcpm
maximizeConversionsBiddingScheme.isRemoveTargetCpa

現在、最大入札価格（CPC、CPV、vCPM）や目標値（tCPA）を0にすると値が削除されますが、今後、0の場合は削除せず値も変更しません。削除する場合は上記の削除フラグをオンにします。

6. インターフェースの統一

Yahoo!広告検索広告 APIとYahoo!広告ディスプレイ広告APIの複数のサービスでインターフェースを統一するため、ディスプレイ広告 APIのフィールド名などを変更しました。

対象サービス

FeedDataService
ReportDefinitionService
StatsService
VideoService
AdGroupAdService
AdGroupService
CampaignService
AuditLogService

内容

・フィールド名の変更

サービス名	変更前のフィールド名	変更後のフィールド名
FeedDataService	fileUploadSrc	fileUploadSource
ReportDefinitionService	displayFieldNameEN	displayFieldNameEn
ReportDefinitionService	displayFieldNameJA	displayFieldNameJa
ReportDefinitionService（getReportFields）	type	reportType
StatsService	vimps	viewableImps
	clickCnt	clicks
	averageRateVideoViewed	avgPercentVideoViewed
	averageDurationVideoViewed	avgDurationVideoViewed
	conversionRate	convRate
	conversionValue	convValue
	valuePerConversions	valuePerConv
	allConversions	allConv
	allConversionRate	allConvRate
	allConversionValue	allConvValue
	valuePerAllConversions	valuePerAllConv
	conversionValueViaAdClick	convValueViaAdClick
	budgetImpressionShareLostRate	impressionShareBudgetLoss
	rankImpressionShareLostRate	impressionShareRankLoss
	viewThroughConversions	convValueViaViewThrough
	valuePerConversionsViaAdClick	valuePerConvViaAdClick
	statsStartDate	startDate
	statsEndDate	endDate
VideoService	creationTime	createdDatetime
CampaignService	containsLabelIdFlg	containsLabel
CampaignService	deviceOsType	appOsType
AdGroupService	containsLabelIdFlg	containsLabel
AdGroupService	containsLabelIdFlg	containsLabel
AuditLogService	updateSource	sourceType

・その他の変更

サービス名	変更内容
ReportDefinitionService	numberResults integer($int32)のdefaultを500に変更
ReportDefinitionService	requestTime, completeTimeの形式をyyyy/MM/dd HH:mm:ssに変更例："requestTime": "2022/08/05 12:30:33"
AdGroupService	以下のmaximumを1000に変更・adGroupIds[] ・campaignIds[]
AdGroupAdService	以下のmaximumを1000に変更・adGroupIds[] ・campaignIds[] ・adIds[]
AdGroupAdService	以下の項目を含む箇所をadType配下から削除し、ad配下に追加・customParameters[] ・smartphoneFinalUrl ・isRemoveSmartphoneUrl ・finalUrl ・displayUrl ・displayUrlLevel ・trackingUrl ・isRemoveTrackingUrl 例：ad.bannerImageAd.finalUrlを削除しad.finalUrlを追加
AuditLogService	sourceType（変更前のフィールド名はupdateSource）で指定できるENUM値に「YAHOO_JAPAN」を追加

7. 保守改善

保守改善としてレポート項目の返却値を一部変更しました。

対象サービス

ReportDefinitionService

内容

画像や動画のピクセルサイズを表すレポート項目「MEDIA_AD_FORMAT」の返却値のうち、「1000×250」を「1200×300」に置き換えて返却
オーディエンスカテゴリータイプの英語返却値のうち「Attribute･Life events」を「Attribute, life events」に表記変更

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

以下の日程でディスプレイ広告 API v8の提供を終了いたします。

サポート終了日：2023年2月27日（月）
システム終了日： 2023年6月23日（金）

また、以前にお伝えしたとおり、ディスプレイ広告 API v7を以下の日程で終了します。

システム終了日： 2023年2月27日（月）
※サポートは終了済みです。

Developer Center