ads-advanced-tools-docs icon indicating copy to clipboard operation
ads-advanced-tools-docs copied to clipboard

Issue Report: /en-us/reference/common-models/enums#placement

Open jasonhebert opened this issue 2 years ago • 2 comments

Describe the bug The documentation describes a campaign.optimization.placementBidAdjustment.placement property as an enum. The documentation lists the available values of that enum as HOME_PAGE, TOP_OF_SEARCH, PRODUCT_PAGE, and REST_OF_SEARCH with mappings to the equivalent values for Sponsored Products and Sponsored Brands. The values that are returned from the API, and listed in the documentation examples, are not the listed values for that enum but the mapped equivalent.

URL of the content https://advertising.amazon.com/API/docs/en-us/reference/common-models/enums#placement

Description of what the documentation currently says The section providing the definition of the Placement enum lists the accepted and mapped values for the enum. The examples also show the mapped value of the enum instead of the stated expected value.

Description of what the documentation should say I am not sure if this is a documentation error or an error in the API responses.

Screenshots image In the following screenshot the value for placement shows the mapped value of PLACEMENT_TOP. The definition of the enum shows that the value should be TOP_OF_SEARCH. image

Additional context

jasonhebert avatar Mar 21 '24 10:03 jasonhebert

I checked with the engineering team, and this is indeed a bug. The documentation reflects the correct values. I'll let you know here when this has been resolved. Thanks for reporting this issue!

elizafarley avatar Mar 21 '24 17:03 elizafarley

Any traction on this or an estimated time for fix?

jasonhebert avatar Apr 03 '24 16:04 jasonhebert