Yahoo! JAPAN Ads API | Developer Center

日本語

2024/10/24

About Yahoo! JAPAN Ads API v15 release

Updates

October 24, 2024: Updated due to the release of API v15

This update includes new information that differs from the initial announcement. Check the following release notes for details.

Yahoo! JAPAN Ads Search Ads API v15 Release Note
Yahoo! JAPAN Ads Display Ads API v15 Release Note

ーーーーーーーーーーーーーー

Yahoo! JAPAN Ads API v15 release

Products

Yahoo! JAPAN Ads Search Ads API

Yahoo! JAPAN Ads Display Ads API

Version released

v15

Schedule

October 23, 2024

*This date is subject to change.

Changes to the Search Ads API

New feature-A/B tests

The Search Ads API supports an "A/B test" that compares ad performance. After the feature is released, it will be available. See the following announcement for details.
A/B test feature will be available

  • Services
    • AbTestService/get, set, remove, graduateTest
    • AuditLogService/add
  • Changes
    • Create a new AbTestService. This service lets you set up A/B tests, obtain information, and more.
    • Add "AB_TEST" to "AuditLogServiceEntityType" in AuditLogService/add.

New feature-Conversion choices used to optimize bid strategies

The Search Ads API includes a feature that lets you select which conversions to use for optimizing your bid strategy for each campaign. Additionally, the API will support creating conversion groups that can combine multiple conversions. You can use both features only after the release. See the following announcement for details.
Feature to select conversions for bid strategy optimization

  • Services
    • ConversionGroupService/add, set, get, remove
    • CampaignService/add, set, get
    • ConversionTrackerService
  • Changes
    • Create a new ConversionGroupService. The service lets you create, update, and retrieve conversion groups.
    • Add "conversionSetting" to CampaignService/add, set, get.
    • Add "origin" (conversion source) to the ConversionTrackerService response.

Remove character code "EUC" from report

All versions, including v15, will not be able to report on the character code EUC.

  • Services
    • ReportDefinitionService
  • Changes
    • Remove "EUC" from reportDownloadEncode.

Remove KeywordForecastMetricsService

  • Services
    • KeywordForecastMetricsService
  • Changes
    • Remove the KeywordForecastMetricsService that is no longer available.

Changes to the Display Ads API

New feature-Gain Friends Ads

Supports "Gain Friends Ads" for the purpose of gaining users as friends on the LINE Official Account. You must link your LINE Official Account to your Display Ads account to use Gain Friends Ads.
Launch of Gain Friends Ads of LINE Official Account

  • Services
    • AccountAuthorityService
    • CampaignService
    • AdGroupService
    • AdGroupAdService
  • Changes
    • Add a "Gain friends" campaign goal that AccountAuthorityService can get.
    • Add "Individual CPF" and "Maximize gaining friends" to the CampaignService bid strategy.
    • Add "Individual CPF" and "Maximize gaining friends" to the AdGroupService bid strategy. Additionally, add a field for specifying the exclusion friend list for the "Gain friends" campaign goal.
    • Add "Responsive (Gain friends)" to the AdGroupAdService.

Addition-New audience list types for Gain Friends Ads

As we launch Gain Friends Ads, we will add audience list types.

  • Services
    • AudienceListService
    • AdGroupTargetService
  • Changes
    • Add "Friends of LINE Official Account" and "Friends who blocked LINE Official Account" to the AudienceListType of the AudienceListService. Additionally, add "LINE Official Account" to AudienceListServiceSourceType.
    • Add AdGroupTargetService's AudienceListType "Friends of LINE Official Account" and "Friends who blocked LINE Official Account."

Add bid strategy "Maximize conversions (with target value)" for optimization in SKAdNetwork and be available for calculating cost per conversion (in beta)

The bid strategy "Maximize conversions (with target value)" will be available for campaigns using ad delivery optimization by SKAdNetwork. Additionally, SKAdNetwork conversions will be available for calculating cost per conversion. This feature is in the beta version, and its behavior may not be stable. *This feature is already available in the Campaign Management Tool. Learn more

  • Services
    • CampaignService
  • Changes
    • Add "Conversions to calculate CPA (SKAdNetwork)" to maximizeConversionsBiddingScheme.

Change display items in performance data

Change the display period of performance data.

  • Services
    • StatsService
    • ConversionTrackerService
  • Changes
    • The aggregation period obtained with StatsPeriod in StatsService and ConversionTrackerService will be the date at the time of API execution. Delete the preliminary and fixed notations for each item.
    • Remove the periodTime field from period.periodEndDate, period.periodStartDate.

Add buttons for Responsive Ads

Add selectable buttons when creating Responsive Ads.
Specification changes for adding ads

  • Services
    • AdGroupAdService/add, set
  • Changes
    • Add the following buttons to the buttonText enum:
    • ゲームプレイ (Play game)
    • アプリを利用 (Use app)
    • 音楽を聴く (Listen to music)

End of specifying multiple accounts for some reports

We will no longer generate reports for some performance reports that specify multiple accounts with MCC accounts. *This feature is already available in the Campaign Management Tool.
End of multiple account designation for some reports and change to data collection period

  • Services
    • ReportDefinitionService
  • Changes
    • Target reports
      Conversion path reports
      Cross-campaign reach reports
      Attribution model comparison reports
    • In v15, remove the following fields in reportTypeCondition:
      /conversionPathReportCondition/conversionPathAccountSetting
      /crossCampaignReachesReportCondition/crossCampaignIds[]/account
      /crossCampaignReachesReportCondition/crossCampaignGoals[]/account
      crossCampaignReachesReportCondition/crossCampaignBuyingTypes[]/account
      /modelComparisonReportCondition/modelComparisonAccountSetting
    • In v14 and earlier versions, setting a value for the above field will cause an error.

Change the bid strategy that is responded to by the AccountAuthorityService

  • Services
    • AccountAuthorityService/get
  • Changes
    • Remove the bid strategy from the response.

Remove discontinued targetTypes

  • Services
    • StatsService
  • Changes
    • Remove PLACEMENT_CATEGORY_DETAIL_TARGET from targetTypes.

Remove Display Ads (Guaranteed) effectiveness measures

  • Services
    • GuaranteedCampaignService
    • DictionaryService
    • SearchLiftService
  • Changes
    • Remove the brandTracking field from GuaranteedCampaignService/get.
    • Remove the DictionaryService/getBusinessCategory.
    • Remove the SearchLiftService.

Remove character code "EUC" from report

All versions, including v15, will not be able to report on the character code EUC.

  • Services
    • ReportDefinitionService
  • Changes
    • Remove "EUC" from reportDownloadEncode.

Remove appConversionType field from ConversionTrackerService

  • Services
    • ConversionTrackerService
  • Changes
    • Remove the appConversionType field.

Remove unnecessary items from reports

  • Services
    • ReportDefinitionService/getReportFields
  • Changes
    • Remove the following unused fields:
    • Ad distribution type (DELIVER)
    • Dynamic image extensions (IMAGE_OPTION)
    • Carrier (CARRIER)

Add "This month (excluding today)" to statsPeriod for ConversionTrackerService and StatsService

  • Services
    • ConversionTrackerService/get
    • StatsService/get
  • Changes
    • Add "This month (excluding today)" to ENUM in statsPeriod.

Comments

  • Find more details in the release notes and reference documents provided in the upcoming release.
  • We will hold an online seminar to give an overview of APIv15 along with the release. Wait for further announcements for more details.

End of earlier versions

Yahoo! JAPAN Ads API v13 will end with the following schedule:

  • Support end date: October 30, 2024
  • End of life date: Early of March 2025 (scheduled)

    *Wait for further announcements with detailed schedules.

Yahoo! JAPAN Ads API v12 will end with the following schedule:

  • End of life date: October 30, 2024

    *Support for this version has already ended.

Developer Center

Related sites: