amzn / ads-advanced-tools-docs

Code samples and supplements for the Amazon Ads advanced tools center
https://advertising.amazon.com/API/docs/en-us/index
MIT No Attribution
87 stars 33 forks source link

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

Open jasonhebert opened 5 months ago

jasonhebert commented 5 months ago

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

elizafarley commented 5 months ago

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!

jasonhebert commented 4 months ago

Any traction on this or an estimated time for fix?