Yahoo!広告 API | Developer Center
English2021/12/15
Yahoo!広告 API v7 システムリリースについて
文書管理番号：APIJ-FY21-2299
お客様各位
平素は弊社サービスに多大なるご支援を賜り、厚く御礼申し上げます。
このたび弊社では、Yahoo!広告 APIの新バージョンをリリースします。
詳細を下記のとおりお知らせいたしますので、ご確認ください。
今後ともYahoo!広告をよろしくお願いいたします。
記
1. 対象サービス：
Yahoo!広告 検索広告 API
Yahoo!広告 ディスプレイ広告 API
2. リリースのバージョン：
v7
3. 実施日（予定）：
2022年1月17日（月）
※日程は変更になる場合があります。
4. 検索広告 APIの変更点：
■入札戦略の名称変更
入札戦略に関する名称を変更します。
・対象サービス
CampaignService
BiddingStrategyService
KeywordForecastMetricsService
KeywordEstimatorService
AdGroupWebpageService
AdGroupCriterionService
AdGroupService
上記のサービスにおいて、以下の名称を変更します。各名称は変更前→
変更後で表しています。
・ENUM
MANUAL_CPC → CPC
TARGET_SPEND → MAXIMIZE_CLICKS
・フィールド
manualCpcBiddingScheme → cpcBiddingScheme
targetSpendBiddingScheme → maximizeClicksBiddingScheme
maxCpc → cpc
adGroupMaxCpc → adGroupCpc
keywordMaxCpc → keywordCpc
■最終リンク先URLに関するフィールドの削除および名称変更
最終リンク先URLに関するフィールドの削除および名称変更を行います。
・対象サービス
AdGroupAdService
AdGroupCriterionService
対象サービスにおいて以下のフィールドを削除します。
additionalAdvancedMobileUrls
additionalAdvancedUrls
対象サービスにおいて以下の名称を変更します。各名称は変更前→
変更後で表しています。
advancedUrl → finalUrl
advancedMobileUrl → smartphoneFinalUrl
reviewAdvancedUrl → reviewFinalUrl
reviewAdvancedMobileUrl →reviewSmartphoneFinalUrl
■コンバージョン測定の目的の細分化
コンバージョン測定の目的を細分化するためConversionTrackerServiceCategory
の追加、名称変更を行います。実際に利用可能になるのは、2022年春
頃を予定しています。機能の詳細は追ってご連絡いたします。
■新広告表示オプションの対応
新しい広告表示オプションに対応します。実際に利用可能になるのは、
2022年初春を予定しています。機能の詳細は、以下のリリースノート
を参照してください。
【検索広告】新形式の広告表示オプションの提供開始について
https://ads-promo.yahoo.co.jp/support/release/30243894.html
これにより、以下のサービスを追加します。
・AssetService / add, get, set, setTrademarkStatus
・AdGroupAssetService / get, set, replace
・CampaignAssetService/ get, set, replace
なお、v6以前のバージョンで提供しているFeedItemServiceは、今後、
提供を終了する予定です。提供終了のスケジュールは追ってご連絡い
たします。
■サイトリターゲティングタグの形式を広告管理ツールと共通化
RetargetingListService/getのadvancedSnippetで取得できるリニュー
アル版のサイトリターゲティングタグを、広告管理ツールと共通のサ
イトジェネラルタグを含む形式に変更します。
■add時の入稿アイテム名やキーワードにおける重複エラーのレスポンス改善（全バージョン）
キャンペーンやキーワードなどの入稿アイテムのadd時に既存の入稿ア
イテムとの重複が見つかった場合、エラーコードに加えて重複する既
存入稿アイテムのIDをレスポンスします。これにより、重複対象とな
る既存のアイテムを見つけやすくなります。この変更は全バージョン
に実施します。
・対象サービスと、重複した場合にレスポンスされるID
CampaignService campaignId
AdGroupService adGroupId
AdGroupAdService adId
AdGroupCriterionService criterionId
5. ディスプレイ広告 APIの変更点：
■入札戦略の名称変更
入札戦略に関する名称を変更します。これにより、以下の変更を実施
します。
・対象サービス
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
■掲載期間の時間指定対応
キャンペーンで設定する掲載期間について、従来の年月日単位に加え、
時・分単位の指定が可能になります。
※広告管理ツールでは先行して提供している機能です。詳しくは以下
のリリースノートを参照してください。
【ディスプレイ広告】キャンペーンの掲載期間への時間指定追加について
https://ads-promo.yahoo.co.jp/support/release/30238167.html
これにより、以下の変更を実施します。
・対象サービス
CampaignService
GuaranteedCampaignService
GuaranteedSimulationService
GuaranteedInventoryService
上記のサービスにおいて、以下のフィールドを追加します。
campaign/startTime
campaign/endTime
guaranteedSimulation/startTime
guaranteedSimulation/endTime
guaranteedInventory/startTime
guaranteedInventory/endTime
■キャンペーン目的、キャンペーン掲載タイプの追加（全バージョン）
キャンペーン目的と掲載タイプを追加します。全バージョンに対応し、
v5、v6ではすでにご利用可能です。
※この機能は一部のお客様のみご利用になれます。詳細は以下を参照
してください。
Yahoo!セールスプロモーション
https://marketing.yahoo.co.jp/service/salespromotion.html
・対象サービス
CampaignServcie
ReportDefinitionService
AccountAuthorityService
・追加するキャンペーン目的
PayPayギフト（PAYPAY_GIFT）
・追加するキャンペーン掲載タイプ
セールスプロモーション（SALES_PROMOTION）
■オーディエンス管理機能の対応
クライアントデータやYahoo! JAPANの持つオーディエンスデータを活
用するためのオーディエンス管理機能に対応します。
※広告管理ツールでは先行して提供している機能です。詳しくは以下
のリリースノートを参照してください。
【ディスプレイ広告】オーディエンス管理機能の提供開始について
https://ads-promo.yahoo.co.jp/support/release/30236037.html
これにより、以下の変更を実施します。
・RetargetingListServiceの名称をAudienceListServiceに変更します。
・AudienceListServiceで、以下のオーディエンスリスト種別の指定が
可能になります。
サイト訪問ユーザー（WEBSITE_VISITORS）
顧客データ（CUSTOMER_DATA）
・一部サービス内のフィールド名称を変更します。各名称は変更前→
変更後で表しています。
-対象サービス
AccountLinkService
-変更するフィールド名
retargetingListSharingEnabled → audienceListSharingEnabled
-対象サービス
AdGroupTargetService
StatsService
GuaranteedInventoryService
GuaranteedSimulationService
-変更するフィールド名
targetListDeliverType → deliverType
targetListName → audienceListName
siteRetargetingTarget → audienceListTarget
targetTypeで指定できるEnumから以下を変更
SITE_RETARGETING → AUDIENCE_LIST_TARGET
-対象サービス
ReportDefinitionService
-変更するフィールド名
targetTypeで指定できるEnumから以下を変更
SITE_RETARGETING → AUDIENCE_LIST_TARGET
■フルHDサイズ、HDサイズの動画に対応
広告に掲載する動画について、フルHDサイズ、HDサイズの操作に対応
します。
これにより、VideoServiceについて以下の点を変更します。
・VideoService/getで、フルHDサイズ、HDサイズの動画のダウンロード
が可能かを見分ける以下のフィールドを追加
video/videoSetting/extraSpecs[]
video/videoSetting/extraSpecs[].qualityType
FULLHD
HD
・VideoService/downloadのqualityTypeフィールドで、フルHDサイズ、
HDサイズの動画を指定可能に。
■ターゲティングの配信設定参照に対応
ディスプレイ広告 APIから、各種ターゲティング設定のオンオフにつ
いて参照が可能になります。
※広告管理ツールでは以前から提供している機能です。
これにより、AdGroupTargetServiceの全てのターゲティングについて、
配信設定を表すフィールド「targetSetting」を追加します。
■コンバージョン経路レポート、横断リーチレポートの改善
コンバージョン経路レポートで、広告グループ単位での経路表示に対
応します。また、一部レポート項目の名称変更と追加を実施します。
※広告管理ツールでは先行して提供予定の機能です。詳しくは以下の
リリースノートを参照してください。
【ディスプレイ広告】コンバージョン経路および横断リーチレポートの改善
https://ads-promo.yahoo.co.jp/support/release/30239946.html
これにより、以下の変更を実施します。
・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
・ReportDefinitionServiceのconversionPathFilterTypeに、以下のENUM
を追加します。
ADGROUP_NAME
ADGROUP_ID
6. 補足：
・各機能に関する詳細は、リリース時に公開されるリリースノート、
およびリファレンスをご確認ください。
7. 旧バージョンの終了について：
Yahoo!広告 API v5の提供を、以下の日程で終了します。
サポート終了日：2022年2月24日（木）
システム終了日：2022年6月8日（水）
また、「Yahoo!広告 API v6 システムリリース完了のお知らせ」（文書管理番
号：APIJ-FY21-2235）でお伝えしたとおり、Yahoo!広告 API v4を、以下の日程
で終了します。
システム終了日：2022年2月24日（木）
※サポートは終了済みです。
以上