Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jasonhebert opened this issue Mar 21, 2024 · 2 comments
Open

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

jasonhebert opened this issue Mar 21, 2024 · 2 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@jasonhebert
Copy link

jasonhebert commented Mar 21, 2024

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 jasonhebert added bug Something isn't working documentation Improvements or additions to documentation labels Mar 21, 2024
@elizafarley
Copy link
Contributor

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 elizafarley self-assigned this Mar 21, 2024
@jasonhebert
Copy link
Author

Any traction on this or an estimated time for fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants