Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

Latest commit

 

History

History
319 lines (298 loc) · 12.1 KB

ReleaseNotes.md

File metadata and controls

319 lines (298 loc) · 12.1 KB
Raw

Release Notes

Sponsored Search API V201901

Release version

V201901 (WSDL Version: V201901)

Main contents of this release

*For Target Data object and Enumuration, please confirm from data directory under API reference directory.

1. Labels feature

The new 'Labels' feature enables to easily group and filter components such as campaigns and ads by setting up optional names to label them. This has been released on the Campaign Management Tool in September 2018.
Learn about details of this feature on the following help page.
What is Labels

The following enhancements have been made on Sponsored Search API V201901:

  1. Create/revise/remove labels
  2. Set a label to campaign and other ad components
Target Web Service

2. Added Standard bidding and removed 'Maximize Conversions' option

Following two bidding settings are available after the new Auto Bidding feature 'Standard Bidding' has been released on December 2018.

  • Standard bidding : The new bidding setting, which can be set on campaign level.
  • Portfolio bidding : Existing bidding setting, which is created on account level and then set to multiple campaigns under the account. With this change, only "TRUE" is available as a value on CrossDeviceConversionFlag on creating/editing a conversion tracking.

Please check the following announcement to learn about change details.
New feature in Sponsored Search auto bidding released

Sponsored Search API V201901 mainly supports followings.

  1. CampaignService supports setting of following auto bidding types as standard bidding
    ‐ Maximize Clicks (TARGET_SPEND)
    ‐ Target CPA (TARGET_CPA)
    ‐ Target ROAS (TARGET_ROAS)
  2. Removed 'Maximize Conversions' (ENHANCED_CPC) option as auto bidding type
Target Web Service

3. Added Custom Key of Site Retargeting

The Custom Key setting became available on Site Retargeting tag.
Creating Target list using the custom key will enable Site Retargeting by accurate conditions.
*The naming of this new feature has been revised from "Custom Parameter" to "Custom key".

Sponsored Search API V201901 mainly supports followings.

  1. The Custom Key setting became available on Site Retargeting tag.
  2. Get Custom key setting information became available.
Remarks

The following behavior changes are planned on V201808 and before after V201901 release, on get/update conditions of Target List with one ore more condition(s) of 'Custom key' (Custom Parameter):

  • Get all conditions set to Target List is unavailable.
  • All of conditions previously set to the Target List are released and only new conditions are enabled.

Therefore you may have unexpected operation results when using 'Custom key' (Custom Parameter) on V201808 or before version.
Please make sure and use the latest API version after V201901 release.

Target Web Service

4. Ad quality improvement

Sponsored Search will have activities for ad quality improvement by trademark restriction to protect brand value.

The change on Sponsored Search API V201901 is following:

  • Add a flag (TrademarkStatus) for trademark restriction and error codes.

*Validation error on ad creation including a restricted trademark (on all available versions).
*We will announce additional information of this activity when available.

Target Web Service

5. Auto-tagging feature is available

Auto-tagging feature supports conversion tracking tags available on secured browsers.

Sponsored Search API V201901 mainly supports followings.

  • Get/update setting informations of auto-tagging is available.

*This feature will be available for limited users.

Target Web Service

6. Maintenance Release

  • Removed some unnecessary items and reviewed some WSDL as system maintenance release.
  • As previously announced on the announcement on September 2018, revised responces of Auto Bidding setting on ad group level on Sponsored Search API. (on all available versions)

*See also the part of 'Impacts on each Version from the change of Services'.

Target Web Service

Impacts on each Version from the change of Services

Service V201808 and before V201901
CampaignService ・No change in API IF.
・Following Auto Bidding types are referable
‐ 'Maximize Clicks'(TARGET_SPEND)
‐ 'Target CPA'(TARGET_CPA)
‐ 'Target ROAS'(TARGET_ROAS)
 ・Getting Label ID is available
・Set/remove/get of following Auto Bidding types as Standard bidding are available
‐ 'Maximize Clicks'(TARGET_SPEND)
‐ 'Target CPA'(TARGET_CPA)
‐ 'Target ROAS'(TARGET_ROAS)
・Removed the related items of Auto Bidding type 'Maximize Conversions'(ENHANCED_CPC)
・Removed Ad Rotation flag
・Removed the related items of previous Auto Bidding (sunset on July, 2014)
BiddingStrategyService No change in API IF. Removed the related items of Auto Bidding type 'Maximize Conversions' (ENHANCED_CPC)
FeedItemService ・No change in API IF.
・Validation error on ad creation including a restricted trademark 		・Validation error on ad creation including a restricted trademark
・The value on flag is referable for confirming trademark restrictions
AdGroupService ・No change in API IF.
・Revised response on Auto Bidding setting on ad group
*Learn about details on announcement on September 2018. 		・Getting Label ID is available
・Removed unnecessary items of Auto Bidding
・Revised the response on Auto Bidding setting on ad group
*Learn about details on announcement on September 2018.
AdGroupAdService ・No change in API IF.
・Validation error on ad creation including a restricted trademark 		・Getting Label ID is available
・Validation error on ad creation including a restricted trademark
・The value on flag is referable for confirming trademark restrictions
AdGroupCriterionService ・No change in API IF. ・Getting Label ID is available
・Removed unnecessary items of Auto Bidding
LabelService - ・Create, edit, remove, get labels is available
CampaignLabelService - ・Set, release of campaign labels is available
AdGroupLabelService - ・Set, release of ad group labels is available
AdGroupAdLabelService - ・Set, release of ad labels is available
AdGroupCriterionLabelService - ・Set, release of keyword labels is available
RetargetingListService No change in API IF.
・On V201808 and before, changed the behavior on get/update conditions of Target List which with one ore more custome key (custom parameter) conditions as follows:
- Get all conditions set to the Target List is unavailable
- All of conditions previously set to the Target List are released and only new conditions are enabled 		・Custom key is available as a condition of Target List
・Get Custom key in the tag for Site Retargeting set to Advertiser's website is available
BidLandscapeService ・No change in API IF. ・Added paging items to the selector of BidLandscapeService.wsdl
AccountTrackingUrlService ・No change in API IF. ・Removed the operator enum value 'ADD' of AccountTrackingUrlService.wsdl (Because it's unprovided)
ConversionTrackerService ・No change in API IF. ・Removed the flag to control Conversions across devices
AccountService ・No change in API IF. ・Set/get Auto-tagging is available
*This feature will be available for limited users
CampaignTargetService ・No change in API IF. ・Revised the response order of Page.Type and totalNumEntries of CampaignTargetService.wsdl like other services
AdGroupWebpageService ・No change in API IF. ・Revised service name on AdGroupWebpageService.wsdl
PageFeedItemService ・No change in API IF. ・Revised service name on AdGroupWebpageService.wsdl
・Revised the value on maxOccurs of operations from "unbounded" to "1" on AdGroupWebpageService.wsdl

Sunset schedule of Sponsored Search API V201805

Sponsored Search API V201805 is scheduled to sunset as follows.

  • Deprecation Date (Support closing on) : February 28, 2019.
  • End of Life Date (System closing on) : May 29, 2019.