Yahoo!広告 API | Developer Center
English2023/01/17
Yahoo!広告 API v10 システムリリースについて
文書管理番号：APIJ-FY22-2387
お客様各位
平素は弊社サービスに多大なるご支援を賜り、厚く御礼申し上げます。
このたび弊社では、Yahoo!広告 APIの新バージョンをリリースします。詳細を下記のとおりお知らせいたしますので、ご確認ください。
今後ともYahoo!広告をよろしくお願いいたします。
記
1. 対象サービス：
Yahoo!広告 検索広告 API
Yahoo!広告 ディスプレイ広告 API
2. リリースのバージョン：
v10
3. 実施日（予定）：
2023年2月14日（火）
※日程は変更になる場合があります。
4. 検索広告 APIの変更点：
■自動入札の目標値に削除フラグを追加
自動入札「コンバージョン数の最大化」および「コンバージョン価値の最大化」の目標値に削除フラグを追加します。
・対象サービス
CampaignService
・変更内容
以下のフィールドを追加します。
maximizeConversionsBiddingScheme.isRemoveTargetCpa
maximizeConversionValueBiddingScheme.isRemoveTargetRoas
現在、自動入札の目標値をnullにすると値が削除されますが、今後、nullの場合は削除せず値も変更しません。削除したい場合は上記の削除フラグをオンにします。
・対象サービス
AdGroupService
・変更内容
以下のフィールドを追加します。
maximizeConversionsBiddingScheme.isRemoveTargetCpa
maximizeConversionValueBiddingScheme.isRemoveTargetRoas
targetCpaBiddingScheme.isRemoveTargetCpa
現在、自動入札の目標値を0にすると値が削除されますが、今後、0の場合は削除せず値も変更しません。削除したい場合は上記の削除フラグをオンにします。
■インターフェースの統一
Yahoo!広告 検索広告 APIとYahoo!広告 ディスプレイ広告APIの複数のサービスでインターフェースを統一するため、検索広告 APIのフィールド名の変更や削除などの変更を行います。
・フィールド名の変更
| サービス名 | 変更前のフィールド名 | 変更後のフィールド名 |
|---|---|---|
| ConversionTrackerService | appPostbackUrlClearFlag | isRemoveUrl |
| CampaignService | containsLabelId | containsLabel（※） |
| appStore | appOsType | |
| AdGroupService | containsLabelId | containsLabel（※） |
| bid | biddingStrategyConfiguration.biddingScheme.cpcBiddingScheme | |
| AdGroupAdService | containsLabelId | containsLabel（※） |
（※）ENUM値からboolean値に変更
・フィールドの削除
| サービス名 | 削除するフィールド |
|---|---|
| CampaignService | budget.budgetPeriod |
| AdGroupService | bid.bidSource |
| targetRoasOverride | |
| targetCpaOverride | |
・フィールドの新規追加
| サービス名 | 新規追加するフィールド |
|---|---|
| AdGroupService | biddingStrategyConfiguration |
| biddingStrategyConfiguration.portfolioBiddingId | |
| biddingStrategyConfiguration.biddingScheme.biddingStrategyType | |
| biddingStrategyConfiguration.biddingScheme | |
|
isRemoveTrackingUrl |
|
・その他の変更
| サービス名 | 変更内容 |
|---|---|
| AccountService |
以下のmaximumとdefaultを500に変更 |
| BudgetOrderService | |
| LabelService | numberResultsのdefaultを2000に変更 |
| AdGroupAdService |
ad.description1とad.headline1を削除し、以下を追加 |
| ReportDefinitionService |
・canFilterをfilterableに変更 |
5. ディスプレイ広告 APIの変更点：
■オーディエンスリスト（Yahoo! Audience Discovery）の提供に対応
新規リスト「オーディエンスリスト（Yahoo! Audience Discovery）」が利用できるようになります。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のお知らせを参照してください。
ディスプレイ広告 新規オーディエンスリストの提供開始、およびオーディエンスリスト（カスタム）の提供終了について
これにより以下の変更を実施します。
・対象サービス
AudienceListSevice
・変更内容
‐audienceListType、sourceTypeにENUM値「YAHOO_JAPAN_AUDIENCE_DISCOVERY」を追加
‐audienceListContentにyahooJapanAudienceDiscoveryAudienceListフィールドを追加
・対象サービス
AdGroupTargetService
GuaranteedAdGroupService
・変更内容
audienceListTypeにENUM値「YAHOO_JAPAN_AUDIENCE_DISCOVERY」を追加
■最適化スコアの提供に対応
自動入札がどの程度最適な運用になっているかを評価する最適化スコアの確認が可能になります。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
【ディスプレイ広告（運用型）】最適化スコア提供開始のお知らせ
これにより以下の変更を実施します。
・対象サービス
AccountService
・変更内容
アカウント単位の最適化スコアを表すフィールドとしてoptimizationScoreを追加
■画像の高画質化機能に対応
画像登録時に画質が粗くならないように調整する高画質化機能に対応します。
※広告管理ツールでは先行して提供している機能です。詳しくは以下のリリースノートを参照してください。
【ディスプレイ広告】画像登録時の高画質化機能について
これにより以下の変更を実施します。
・対象サービス
MediaService
・変更内容
mediaRecord.imageMedia.upscaleImageEnabledを追加
初期設定は「高画質化を実施する（オン）」の状態です。なおv9以前のバージョンでは利用できないため、画像登録時に高画質化は実施されません。
■広告グループ入札価格および目標単価に削除フラグを追加
広告グループの入札戦略に設定する最大入札価格（CPC、CPV、vCPM）および目標値（tCPA）の削除フラグを追加します。
・対象サービス
AdGroupService
・変更内容
以下のフィールドを追加します。
‐cpcBiddingScheme.isRemoveCpc
‐cpvBiddingScheme.isRemoveCpv
‐vcpmBiddingScheme.isRemoveVcpm
‐maximizeConversionsBiddingScheme.isRemoveTargetCpa
現在、最大入札価格（CPC、CPV、vCPM）や目標値（tCPA）を0にすると値が削除されますが、今後、0の場合は削除せず値も変更しません。削除したい場合は上記の削除フラグをオンにします。
■インターフェースの統一
Yahoo!広告 検索広告 APIとYahoo!広告 ディスプレイ広告APIの複数のサービスでインターフェースを統一するため、ディスプレイ広告 APIのフィールド名などを変更します。
・フィールド名の変更
| サービス名 | 変更前のフィールド名 | 変更後のフィールド名 |
|---|---|---|
| FeedDataService | fileUploadSrc | fileUploadSource |
| ReportDefinitionService | displayFieldNameEN | displayFieldNameEn |
| displayFieldNameJA | displayFieldNameJa | |
| 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 |
| AdGroupAdService | adStyle | mainMediaFormat |
| GuaranteedAdGroupAdService | ||
| PlacementUrlIdeaService |
・その他の変更
| サービス名 | 変更内容 |
|---|---|
| ReportDefinitionService | numberResults integer($int32)のdefaultを500に変更 |
|
requestTime, completeTimeの形式をyyyy/MM/dd HH:mm:ssに変更 |
|
| ReportDefinitionService（getReportFields） | typeをreportTypeに変更 |
| AdGroupService |
以下のmaximumを1000に変更 |
| AdGroupAdService |
以下のmaximumを1000に変更 |
| CampaignService | containsLabelIdFlgをcontainsLabelに変更 |
| AdGroupService | |
| AdGroupAdService | |
| CampaignService | deviceOsTypeをappOsTypeに変更 |
| AdGroupAdService |
以下の項目を含む箇所をadType配下から削除し、ad配下に追加 |
■保守改善
レポート項目の返却値を一部、変更します。
・対象サービス
ReportDefinitionService
・変更内容
‐画像や動画のピクセルサイズを表すレポート項目「MEDIA_AD_FORMAT」の返却値のうち、「1000×250」を「1200×300」に置き換えて返却します。
‐オーディエンスカテゴリータイプの英語返却値のうち「Attribute･Life events」を「Attribute, life events」に表記変更します。
6. サンプルプログラムのopenapi-generator6系の対応
■対象サービス
Yahoo!広告 検索広告
Yahoo!広告 ディスプレイ広告
■実施日（予定）
2023年2月15日（水）
※日程は変更になる場合があります。
■概要
python, php, rubyのサンプルにおいて、openapi-generator6系の対応を実施します。
7. 補足：
・各機能に関する詳細は、リリース時に公開されるリリースノート、およびリファレンスをご確認ください。
・リリースに合わせて、API v10の概要などをお伝えするオンラインセミナーを開催する予定です。詳細は別途お知らせします。
8. 旧バージョンの終了について：
Yahoo!広告 API v8の提供を、以下の日程で終了します。
サポート終了日：2023年2月27日（月）
システム終了日：2023年6月23日（金）
また、「Yahoo!広告 API v9 システムリリース完了のお知らせ」（文書管理番
号：APIJ-FY22-2315）でお伝えしたとおり、Yahoo!広告 API v7を以下の日程
で終了します。
システム終了日：2023年2月27日（月）
※サポートは終了済みです。
以上