Yahoo!広告 API | Developer Center

English

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

リリースバージョン

v11

リリース日

2023年6月12日（月）

本リリースの主な内容

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

1. 最適化提案の改善に伴うインターフェースの変更

最適化提案の機能改善に伴い、インターフェースを変更しました。なお、v10以前のバージョンも併せて変更しています。改善内容の詳細は以下のお知らせをご確認ください。
【ディスプレイ広告（運用型）】最適化提案における画像・動画の更新提案の変更について

対象サービス

RecommendationService

内容

  • レスポンスからviewableCtrTwoMonthsAgoを削除しました。

  • レスポンスにpreviousViewableCtrを追加しました。

※v10以前ではviewableCtrTwoMonthsAgoが全てnullで返却されます。

2. ConversionTrackerServiceの統計情報取得の仕様変更

ConversionTrackerServiceにおいて、従来はget、add、setで以下の統計情報を返却していましたが、getのみ返却する仕様に変更しました。

対象サービス

ConversionTrackerService

内容

getのみ以下のフィールドを返却します。

ConversionTrackerServicePageオブジェクト

・totalAllConversionValue
・totalAllConversions
・totalConversionValue
・totalConversionValueViaAdClick
・totalConversions
・totalConversionsViaAdClick
・totalCrossDeviceConversions
ConversionTrackerオブジェクト

・allConversionValue
・allConversions
・conversionValue
・conversionValueViaAdClick
・conversions
・conversionsViaAdClick
・crossDeviceConversions
・statsPeriodCustomDate

3. 統計情報の集計可能な期間を拡大

統計情報において、集計可能な最大期間を過去37カ月に拡大します。実際に取得可能になるのは2023年6月21日（水）を予定しています。詳しくは以下のお知らせをご確認ください。
ディスプレイ広告 パフォーマンスデータの集計可能な期間の拡大について

対象サービス

StatsService
ConversionTrackerService

内容

statsPeriod: REALTIME_LAST37MONTH を追加しました。

4. コンテンツキーワードターゲティングのレポート取得に対応

コンテンツキーワードターゲティングのレポートが作成できるようになりました。

対象サービス

ReportDefinitionService

内容

reportTypeにCONTENT_KEYWORD_LISTを追加しました。
※CONTENT_KEYWORD_LISTはgetReportFieldsでのみ指定可能です。

5. 入札戦略の拡張クリック単価を追加

入札戦略においてベータ版として提供している「拡張クリック単価（eCPC）」に対応しました。

対象サービス

CampaignService
AdGroupService

内容

biddingStrategyConfiguration.biddingScheme.cpcBiddingSchemeオブジェクトにenhancedCpcEnabledを追加しました。
enhancedCpcEnabledにTRUEを指定すると拡張クリック単価（eCPC）が有効になります。FALSEを指定すると最大入札価格指定（CPC）となります。

注意事項

  • ｖ11以降、enhancedCpcEnabledは設定必須です。そのため既存のキャンペーンや広告グループで最大入札価格（CPC）の値を更新する場合も必ずenhancedCpcEnabledをFALSEで指定する必要があります。

  • v10以前のバージョンで「拡張クリック単価（eCPC）」を利用しているキャンペーンや広告グループの情報を取得すると、入札戦略は「UNKNOWN」と表示されます。

6. リンク先URLのフィールドを削除

リンク先URLが設定されている広告は2022年11月以降に掲載を停止しており、現在は利用していないため、リンク先URLのフィールドを削除しました。

対象サービス

AdGroupAdService
ReportDefinitionService

内容

  • AdGroupAdServiceからurlを削除しました。

  • ReportDefinitionServiceのレポートフィールドから「URL_ID（リンク先URLID）」および「URL_NAME（リンク先URL）」を削除しました。

7. レポート項目名称の変更

Yahoo!広告 ディスプレイ広告 APIとYahoo!広告 検索広告 APIでレポートの項目名称を統一するため、検索広告 APIと名称をあわせたフィールドを追加しました。従来のフィールドも利用可能ですが、今後廃止予定のため、新しいフィールドをご利用ください。

対象サービス

ReportDefinitionService

内容

以下のフィールドを追加しました。各フィールドで取得できる値は右側の従来のフィールドと同じです。

新規追加したフィールド従来のフィールド（今後廃止予定）
BUDGET_LOST_IMPRESSION_SHARE IMPRESSION_SHARE_BUDGET_LOSS
CLICKS CLICK
VIEWABLE_CLICKS VIEWABLE_CLICK
CAMPAIGN_START_DATE START_DATE
CAMPAIGN_END_DATE END_DATE
CITY CITY_NAME
PREFECTURE PREF_NAME
PREFECTURE_ID PREF_ID
WARD WARD_NAME

8. 利用不可の入札戦略を削除

利用できない入札戦略「AUTO」および「NONE」を削除しました。

対象サービス

CampaignService
AdGroupService

内容

CampaignServiceBiddingStrategyTypeにおいて以下を削除しました。

  • AUTO（自動入札）

  • NONE（入札戦略指定なし）

9. 操作履歴ファイルの文字コード指定に対応

操作履歴ファイルの作成時に文字コードの指定が可能になりました。

対象サービス

AuditLogService（add）

内容

リクエストのフィールドにencodingを追加しました。指定できる文字コードはSJISまたはUTF8です。

10. 保守改善

  • AdTypeによる絞り込み検索に対応
    AdGroupAdService（get）およびGuaranteedAdGroupAdService（get）のリクエストにadTypesを追加しました。

  • プレイスメントリストのURL候補から広告タイプ情報を削除
    PlacementUrlIdeaServiceのリクエストおよびレスポンスからAdFormatを削除しました。

Java利用者向けのクライアントライブラリのリリースについて

Java利用者向けに公開しているYahoo!広告 APIのクライアントライブラリのv11対応版より、Spring Framework 5系, 6系それぞれに対応するバージョンをリリースします。詳細は以下のお知らせをご確認ください。
Yahoo!広告 API v11 システムリリース完了のお知らせ

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

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

  • サポート終了日：2023年6月26日（月）

  • システム終了日：2023年10月23日（月）

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

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

Developer Center

関連サイト