Yahoo!広告 API | Developer Center

English

2023/05/10

Yahoo!広告 API v11 システムリリースについて

Yahoo!広告 APIの新バージョンをリリースします。詳細を下記のとおりお知らせいたしますので、ご確認ください。

対象サービス

Yahoo!広告 検索広告 API
Yahoo!広告 ディスプレイ広告 API

リリースのバージョン

v11

実施日（予定）

2023年6月12日（月）
※日程は変更になる場合があります。

検索広告 APIの変更点

■レポート項目名称の変更
Yahoo!広告 検索広告 APIとYahoo!広告 ディスプレイ広告APIでレポートの項目名称を統一するため、対象のフィールド名を変更します。

  • 対象サービス
    ReportDefinitionService（getReportFields）

  • 変更内容

変更前のフィールド名変更後のフィールド名
displayFieldNameEN displayFieldNameEn
displayFieldNameJA displayFieldNameJa

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

  • 対象サービス
    ConversionTrackerService

  • 変更内容
    getのみ以下のフィールドを返却します。

ConversionTrackerServicePageオブジェクト

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

・allConversionValue
・allConversions
・conversionValue
・conversions

■操作履歴ファイル一部文字コードの削除
操作履歴ファイルのエンコード形式から、以下の文字コードを削除します。

  • 対象サービス
    AuditLogService

  • 変更内容
    フィールド「encoding」で指定できる文字コードから「UTF16LE」を削除します。

■提供終了済みサービスの削除
提供を終了したサービスをインターフェースから削除します。

  • 対象サービス
    FeedService（add, set, remove）
    CampaignFeedService（get, set）
    AdGroupFeedService（get,set）
    FeedItemService（add, set, remove, setTrademarkStatus）
    PageFeedItemService（get, download, downloadErrorFile, getReviewSummary, getJobStatus, add）

ディスプレイ広告 APIの変更点

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

  • 対象のサービス
    RecommendationService

  • 変更内容
    ‐　レスポンスからviewableCtrTwoMonthsAgoを削除します。
    ‐　レスポンスにpreviousViewableCtrを追加します。
    v10以前ではviewableCtrTwoMonthsAgoが全てnullで返却されます。

■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

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

  • 対象サービス
    AdGroupAdService
    ReportDefinitionService

  • 変更内容
    ‐　AdGroupAdServiceからurlを削除します。
    ‐　ReportDefinitionServiceのレポートフィールドから「URL_ID（リンク先URLID）」および「URL_NAME（リンク先URL）」を削除します。

■利用不可の入札戦略を削除
現在利用できない入札戦略「AUTO」を削除します。

  • 対象サービス
    CampaignService
    AdGroupService

  • 変更内容
    CampaignServiceBiddingStrategyTypeのAUTO（自動入札）を削除します。

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

  • 対象サービス
    AuditLogService（add）

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

■保守改善

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

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

補足

  • 各機能に関する詳細は、リリース時に公開されるリリースノート、およびリファレンスをご確認ください。

  • リリースに合わせて、APIv11の概要などをお伝えするオンラインセミナーを開催する予定です。詳細は別途お知らせします。

旧バージョンの終了について

Yahoo!広告 APIv9の提供を以下の日程で終了します。
　サポート終了日：2023年6月26日（月）
　システム終了日：2023年10月23日（月）

また、Yahoo!広告 APIv8の提供を以下の日程で終了します。
　システム終了日：2023年6月26日（月）
　※以前お伝えしたシステム終了日より延長しています。なお、サポートは終了済みです。

Developer Center

関連サイト