Yahoo! JAPAN Ads API | Developer Center

日本語

Display Ads API v15 Release Note

Version released

v15

Date

October 23, 2024

Key points of this release

*Learn more about objects, etc. in the reference document.

1. 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

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

2. Addition-New audience list types for Gain Friends Ads

As we launch Gain Friends Ads, we added audience list types.

Service
  • AudienceListService
  • AdGroupTargetService
Changes
  • Added "Friends of LINE Official Account" and "Friends who blocked LINE Official Account" to the AudienceListType of the AudienceListService. Additionally, added "LINE Official Account" to AudienceListServiceSourceType.
  • Added "Friends of LINE Official Account" and "Friends who blocked LINE Official Account" to AdGroupTargetService's AudienceListType.

3. Addition-Bid strategy "Maximize conversions (with target value)" for optimization in SKAdNetwork and support calculating cost per conversion

The bid strategy "Maximize conversions (with target value)" is available for campaigns using ad delivery optimization by SKAdNetwork. Additionally, SKAdNetwork conversions are available for calculating cost per conversion.

※This feature is already available in the Campaign Management Tool.
Display Ads (Auction): Add features to SKAdNetwork Part 2

Service
  • CampaignService
Changes
  • Added "Conversions to calculate CPA (SKAdNetwork)" to maximizeConversionsBiddingScheme.

4. Change display items in performance data

Changed the display period of performance data.

Service
  • StatsService
  • ConversionTrackerService
Changes
  • The aggregation period obtained with StatsPeriod in StatsService and ConversionTrackerService became the date at the time of API execution. In addition, the preliminary and fixed notations for each item have been deleted.
  • Removed the periodTime field from period.periodEndDate, period.periodStartDate.

5. Added buttons for Responsive Ads

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

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

6. End of specifying multiple accounts for some reports

We no longer generate reports for some performance reports that specify multiple accounts with MCC accounts.

※This feature has already been discontinued in the Campaign Management Tool.
End of multiple account designation for some reports and change to data collection period

Service
  • ReportDefinitionService
Changes
  • Target reports
    • Conversion path reports
    • Cross-campaign reach reports
    • Attribution model comparison reports
  • In v15, removed 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 fields will cause an error.

7. New feature to upload customer data to the audience list without having to sign in

Added the functionality to upload customer data to the target audience list from the URL for uploading audience list (customer data) generated in the Campaign Management Tool.

※This feature is already available in the Campaign Management Tool.
Upload customer data to the audience list without sign-in

Service
  • AudienceListService/get UploadUserListStatus
Changes
  • "Upload source" has been added to the response.

8. Maintenance and improvements

  • Removed bid strategy from AccountAuthorityService/get response.
  • Removed the discontinued PLACEMENT_CATEGORY_DETAIL_TARGET from targetTypes of StatsService.
  • Removed the Display Ads (Guaranteed) effectiveness measures.
    • Removed the brandTracking field from GuaranteedCampaignService/get.
    • Removed the DictionaryService/getBusinessCategory.
    • Removed the SearchLiftService.
  • Removed appConversionType field from ConversionTrackerService.
  • Removed the following unused fields from ReportDefinitionService/getReportFields:
    • Ad distribution type (DELIVER)
    • Dynamic image extensions (IMAGE_OPTION)
    • Carrier (CARRIER)
  • Added "This month (excluding today)" to statsPeriod for ConversionTrackerService and StatsService.
  • All versions, including v15, now return the following fields in ReportDefinitionService/getReportFields:
    • Week (Mon-Sun)
  • Fixed the entityType description of eventSelector in AuditLogService to tabular format.
  • *There is no change in functions, etc., only a modification of the reference.
  • Added search feature by system update date.
    • Service: CampaignService/get, AdGroupService/get, AdGroupAdService/get
    • Added "updatedDateRange" to the request.
    • Added "updatedDate" to the response.
  • Changed error codes when creating/editing combined lists in add and set of AudienceListService.
    • Before
      • When creating
        • Audience list with no base list: 210001
        • Non-shared audience list with base list other accounts: 210001
        • List type of base list is combination list: 210001
      • When modifying
        • Audience list with no base list: I0001
        • Non-shared audience list with base list other accounts: 210001
        • List type of base list is combination list: 210001
    • After
      • Error code in all the above cases: V0001

9. Remove character code "EUC" from report

All versions, including v15, no longer support reports using the character code EUC.

Service
  • ReportDefinitionService
Changes
  • Removed "EUC" from reportDownloadEncode.

Comments

We will hold an online seminar to give an overview of API v15 along with the release. See the following announcement for details.
Yahoo! JAPAN Ads API Webinar November 2024

End of Display Ads API v13

Display Ads API v13 will end with the following schedule:

Support end date: October 30, 2024
End of life date: Early March 2025 (scheduled)
*Wait for further announcements with detailed schedules.

Display Ads API v12 will end with the following schedule:

End of life date: October 30, 2024
*Support for this version has already ended.

Updates

October 25, 2024: We removed "in beta" expressions from the section "Add bid strategy "Maximize conversions (with target value)" for optimization in SKAdNetwork and be available for calculating cost per conversion."

Developer Center

Related sites: