amzn / ads-advanced-tools-docs Goto Github PK
View Code? Open in Web Editor NEWCode samples and supplements for the Amazon Ads advanced tools center
Home Page: https://advertising.amazon.com/API/docs/en-us/index
License: MIT No Attribution
Code samples and supplements for the Amazon Ads advanced tools center
Home Page: https://advertising.amazon.com/API/docs/en-us/index
License: MIT No Attribution
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
It's giving the error message that the "budget currency code cannot be null", even though the documentation says it can/should be left be blank.
So either the documentation is not up to date, or there is a bug with the actual bulk files themselves.
URL of the content
https://advertising.amazon.com/API/docs/en-us/bulksheets/2-0/bulksheets-portfolios
Description of what the documentation currently says
"7. Column G - Budget Currency: (Leave blank) You can leave this field blank, it will be auto-populated with your local currency."
Description of what the documentation should say
That's what I'd like to know! The bulk upload error sheet (aka "Upload Processing Summary") is giving me the error message "budget currency code cannot be null"
Additional context
Here the orginal sheet (1st tab) that was uploaded, and the error messages from Amazon (2nd + 3rd tab):
https://docs.google.com/spreadsheets/d/12rzi1DsCpZBrpKDEqrC-4wvN0iVBV9bALYTqc-kpTbM/edit#gid=94990041
I am not able to find Sponsored Display keyword API for listing, creating, updating, and deleting.
As per the document SP and SB keyword API are getting but not getting SD. Can you please give me SD keyword API as soon as possible,
When I try to use negative keywords api, I am getting a 415 error.
But there is no workaround for this error in the documentation.
the link is : /v2/sp/campaignNegativeKeywords
My json data is:
[
{
"campaign_id": 227127083389297,
"state": "enabled",
"keywordText": "helloworld",
"matchType": "negativeExact"
}
]
Describe the bug
According to the docs and APi schema a DspImageCreativeV1
should always have both name
and advertiserId
but these are sometimes missing in /dsp/creatives/image
. When you retrieve the listing of creatives both fields are always present though.
URL of the content
https://advertising.amazon.com/API/docs/en-us/dsp-campaigns/#/Image%20Creative/getImageCreatives
Description of what the documentation currently says
Says both name
and advertiserId
are required
Description of what the documentation should say
Either make these fields always present or update the schema to say these fields are optional
Describe the bug
The link of API Service Desk (https://amzn-clicks.atlassian.net/servicedesk/customer/portal/2/group/2) is not accessible even though I already accepted the invitation from, [email protected]
URL of the content
https://advertising.amazon.com/API/docs/en-us/info/support
Additional context
I can access another portal of Advertising APIs (https://amzn-clicks.atlassian.net/servicedesk/customer/portals). However, this portal is limited to onboarding/registration help. I cannot ask technical questions, or submit API bugs there.
We wish to access the amazon advertising API and we follow the steps in this link to apply as a partner. However when we tried to submit an application we encountered an error that says,
Please ensure that you are signed into the Amazon account affiliated with your corporate email address. If you do not have an Amazon account affiliated with your corporate email address, you may update your current Amazon account or create an account
We have tried various accounts and email addresses affiliated with Amazon but it still produces the same error. I don't understand what corporate email address are they referring to. How do we resolve this?
Hi,
I am following exactly steps to create PD campaign via this link:
https://advertising.amazon.com/API/docs/en-us/sponsored-display/tutorials/how-to-build-audt-campaigns
Payload:
[ { "name": "martin postman Product Targeting Campaign", "tactic": "T00020", "startDate": "20221009", "endDate": "20201231", "state": "enabled", "budget": 1.0, "budgetType": "daily" } ]
However the error comes:
[
{
"code": "INVALID_ARGUMENT",
"description": "Tactic must be one of [remarketing]"
}
]
Both "tactic": "T00020" or "T00030" giving same error.
I am testing in Test account.
endpoint: PUT /dsp/lineItems/
There is no way to update line_item when you want to change targeting because of appliedFess field. I've got the latest from GET:
{
'amazonDspConsoleFee': {'feePercentage': '10'},
'audienceFees': [
{'feeName': 'IN_MARKET_LIFESTYLE', 'amount': '1'},
{'feeName': 'AUTOMOTIVE', 'amount': '0'}
]
}
Anyway when you want to update targeting it throws an error:
{'errorType': 'IMMUTABLE_FIELD', 'message': 'Field appliedFees/audienceFees cannot be updated.'
Can't you just do it read-only, there is no need to provide it in PUT/CREATE.
Describe the bug
We are calling this API - https://advertising-api-eu.amazon.com/sb/campaigns to get all the metrics against each Ad group, campaign data from Amazon Ads API. However, there are sb2 campaigns that are shown in the front-end report which are not available in the data sent via API.
Why my campaign have no impressions?
hello guys Why i've create to many ads campaigns with different targeting types (automatique and manual) but all those campaigns doesn't get anything no impressions no click its look like they are not active even their statut is "Running"
how to fix this problem ?
Hello,
Using the new SP v3 Reporting API, we have observed variations between the output from the API and the report exported from Reporting. For example, the spPurchasedProduct
API report type compared to the reporting UI export (i.e., Sponsored Product - Purchase Product - Daily).
If a report is exported from reporting, say for March 30th, 2023, and a request is made to the API for spPurchasedProduct
, with the same date (DAILY), it will yield some overlap in records, but there will be rows not found in the API output and rows from the API not in the export.
Typically, the report export, while not perfect, is usually a reasonable cross-reference to the output from the API, all other things being equal.
In reviewing the docs, I had not seen anything that may explain variations between the two. Any clarification can help us better document these observations for our customers.
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
There is Typo in Requesting Reports page
URL of the content
https://advertising.amazon.com/API/docs/en-us/tutorials/sponsored-ads-reports#requesting-reports
Description of what the documentation currently says
From: "POST /v2/hsa/{recordType/report"
Description of what the documentation should say
To: "POST /v2/hsa/{recordType}/report"
Close middle size braket needed
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
Incorrect code snippet to set isOptedOutForAverageDailyBudgetIncrease to false,
on page https://advertising.amazon.com/API/docs/en-us/guides/account-management/average-daily-budget
URL of the content
https://advertising.amazon.com/API/docs/en-us/guides/account-management/average-daily-budget
Description of what the documentation currently says
It says
use POST /accountBudgets/featureFlags and set isOptedOutForAverageDailyBudgetIncrease to false
However in code snippet from where user can copy payload it says
{ "featureFlags": { "isOptedOutForAverageDailyBudgetIncrease": true } }
Description of what the documentation should say
For code snippet it should be
{ "featureFlags": { "isOptedOutForAverageDailyBudgetIncrease": false } }
Additional context
Add any other context about the problem here.
Describe the bug
I was trying to generate the report for SP summary keywords via API is incorrect with actual productname
URL of the content
https://advertising-api.amazon.com/reporting/reports
Description of what the documentation currently says
https://advertising.amazon.com/API/docs/en-us/reporting/v3/metrics#portfolioid
The portfolio the campaign is associated with.
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
In the Valid keyword characters, "
is said to be valid keyword character.
But when i created sp keyword containing "
(e.g. 4" desk), (amazon CreateSponsoredProductsKeywords api) failed with message:
{ "errorValue": { "malformedValueError": { "cause": {}, "message": "Keyword is invalid", "reason": "PATTERN_NOT_MATCHED" } }, "errorType": "malformedValueError" }
URL of the content
https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#valid-keyword-characters
Description of what the documentation currently says
"
is in the valid keyword characters, but CreateSponsoredProductsKeywords api faied to add keywords containing "
.
Description of what the documentation should say
Not sure. Need to check whether "
is a valid keyword character.
Additional context
We are now building the OAuth flow to easily connect new Amazon Ads accounts to our platform. We've noticed a small inconsistency in the documentation, hence I would like to clarify it.
We can pass a "state" parameter in the URL, which will be later returned to the redirect page (so we can capture the flow from the start to the end with it).
We managed to build our authorization flow to use this parameter. And it works very well (similar to Selling Partner API). I want to confirm that this parameter will be supported. The older documentation version had this information, but I see it now disappeared (and I can't find any versioning to send you the example).
The URL parameters from the doc linked to this GitHub:
https://advertising.amazon.com/API/docs/en-us/getting-started/create-authorization-grant
The above document doesn't mention the "state" parameter.
this api response needs to have adGroupId field in the docs. It is exists in the actual responses.
Describe the bug
searchTermImpressionRank, searchTermImpressionShare are still mentioned even though the metrics are no longer available in both v2/v3 report APIs.
URL of the content
Keyword reports => Available metrics => Sponsored Brands (version 3)
https://advertising.amazon.com/API/docs/en-us/reporting/v2/report-types#available-metrics-6
Search term reports => Available metrics => Sponsored Brands (version 3)
https://advertising.amazon.com/API/docs/en-us/reporting/v2/report-types#available-metrics-6
Description of what the documentation should say
The metrics, searchTermImpressionRank, searchTermImpressionShare, should be removed from the document of the reporting APIs. With that, developers are not confused whether the metrics can be retrieved with Advertising Report APIs
Screenshots
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
In the Get keyword recommendations section of the Amazon Advertising API, the correct value for the recommendationType parameter is KEYWORDS_FOR_ADGROUP (not KEYWORD_FOR_ADGROUP).
URL of the content
https://advertising.amazon.com/API/docs/en-us/sponsored-products/3-0/openapi/prod
Description of what the documentation currently says
Describe the section/paragraph of the documentation where you see the bug.
Description of what the documentation should say
A clear and concise description of the guidance you expected to see in the documentation.
Screenshots
If applicable, add screenshots to help explain your problem.
Additional context
Add any other context about the problem here.
How can I get an organic and sponsored position in Amazon ads for the campaign?
Please give me an answer as soon as possible.
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Campaigns/createCampaigns
The createCampaign API endpoint (/sd/Campaigns) currently says
Required fields are name, tactic, state, budget, and startDate.
But, as an API user I can create a campaign without budget. (refer to the screenshot below, where I could create a campaign without specifying budget)
Reason: If the budget parameter is not specified in the request body, then a default budget automatically gets assigned to it during campaign creation.
Expected:
The documentation should be updated to say
Required fields are name, tactic, state, and startDate. (because budget is really not a required json field)
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
The sample call of Campaign daily report grouped by campaign and ad group is missing " in the timeUnit key.
URL of the content
https://advertising.amazon.com/API/docs/en-us/guides/reporting/v3/report-types
Description of what the documentation currently says
curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
"name":"SP campaigns report 7/5-7/10",
"startDate":"2022-07-05",
"endDate":"2022-07-10",
"configuration":{
"adProduct":"SPONSORED_PRODUCTS",
"groupBy":["campaign","adGroup"],
"columns":["impressions","clicks","cost","campaignId","adGroupId","date"],
"reportTypeId":"spCampaigns",
timeUnit":"DAILY",
"format":"GZIP_JSON"
}
}'
Description of what the documentation should say
curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
"name":"SP campaigns report 7/5-7/10",
"startDate":"2022-07-05",
"endDate":"2022-07-10",
"configuration":{
"adProduct":"SPONSORED_PRODUCTS",
"groupBy":["campaign","adGroup"],
"columns":["impressions","clicks","cost","campaignId","adGroupId","date"],
"reportTypeId":"spCampaigns",
"timeUnit":"DAILY",
"format":"GZIP_JSON"
}
}'
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
Missing docs for portfolio real-time budget usage.
URL of the content
https://advertising.amazon.com/API/docs/en-us/info/release-notes#budget-usage-percentage-now-available-for-real-time-pulls-in-amazon-ads-api
Description of what the documentation currently says
"You can pull budget usage information for both campaigns and portfolios."
Description of what the documentation should say
Link to information how to pull live budget usage for portfolios.
Screenshots
If applicable, add screenshots to help explain your problem.
Additional context
Nothing to be found in the portfolio docs.
https://advertising.amazon.com/API/docs/en-us/reference/2/portfolios#/Portfolios
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
When I try to call this API, I frequently receive a 429 too many requests error code. However, I am certain that I am making the API calls at a slow rate. Even when I wait for almost 10 minutes before attempting to call again, I still encounter the 429 error code. I'm unsure how to resolve this issue.
Request Url: https://advertising-api.amazon.com/history
Request Boyd:
{ "fromDate": 1680141792000, "toDate": 1687831392000, "count": 200, "sort": { "key": "DATE", "direction": "DESC" }, "eventTypes": { "PRODUCT_TARGETING": { "filters": [ "BID_AMOUNT" ], "eventTypeIds": [ "224633123219965" ], "parents": [ { "useProfileIdAdvertiser": true } ] } }
Response:
{ "body": { "message": "Too Many Requests" }, "header": { "server": "Server", "date": "Tue, 27 Jun 2023 02:03:14 GMT", "content-type": "application/json", "content-length": "31", "connection": "keep-alive", "x-amz-rid": "5FT3ERKD9A201XBRB775", "x-amzn-requestid": "10560978-1702-4bea-b8e7-b3899fcfeda0", "x-amzn-errortype": "TooManyRequestsException", "x-amz-apigw-id": "HJ93dEztIAMF4QA=", "x-amzn-trace-id": "Root=1-649a4362-c2ec76b615af2e225362ddf1", "vary": "Content-Type,Accept-Encoding,User-Agent", "strict-transport-security": "max-age=47474747; includeSubDomains; preload" }, "statusCode": 429, "errorCode": 0 }
Recently updated api request error,I have been using the previous api for over 2 years!
Is there a problem with the api?
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
the sponsored display type always returns empty data, but I'm certain that there is history change data for this type.
URL of the content
Request Url: https://advertising-api.amazon.com/history
Hi elizafarley
When we create subscription, datasetId includes sp-conversion, sp-traffic, budget-usage, sd-traffic, sd-conversion, sponsored-ads-campaign-diagnostics-recommendations and retail-sales-metrics, but https://github.com/amzn/ads-advanced-tools-docs/blob/main/amazon_marketing_stream/Stream_SQS%20_CF_Template.yaml only includes 4 queues (sp-conversion, sp-traffic, budget-usage, sd-traffic, sd-conversion). How to create SQS queues with campaign-diagnostics-recommendations and retail-sales-metrics ?
Additional context
thanks and hope for your reply :)
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
A clear and concise description of what the bug is.
URL of the content
Provide the advanced tools center or GitHub URL where you see the bug.
Description of what the documentation currently says
Describe the section/paragraph of the documentation where you see the bug.
Description of what the documentation should say
I am not able to generate report for sponsor brands with spend and sales field can you please provide me more information about this API .
Screenshots
If applicable, add screenshots to help explain your problem.
Additional context
Add any other context about the problem here.
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
A clear and concise description of what the bug is.
URL of the content
Provide the advanced tools center or GitHub URL where you see the bug.
Description of what the documentation currently says
Describe the section/paragraph of the documentation where you see the bug.
Description of what the documentation should say
A clear and concise description of the guidance you expected to see in the documentation.
Screenshots
If applicable, add screenshots to help explain your problem.
Additional context
Add any other context about the problem here.
Callback from image_creative creation (I'm using "Content-Type": "application/json" Header):
{'requestId': 'b9cca00d-883c-4481-b2f7-3639f931c3a4', 'message': "Invalid 'Content-Type' Header provided."} 'reason': 'Unsupported Media Type'
There is a possibility that's wrong response and there is no problem with Content-Type. but anyway missleading
Docs
There is no information about any additional Content-Type Header.
https://advertising.amazon.com/API/docs/en-us/dsp-campaigns/#/Image%20Creative/CreateImageCreative
URL of the content
I followed your setup for API.
Provide the advanced tools center or GitHub URL where you see the bug.
I'm having issue with Sponsored Brands product targeting endpoints above, the Accept Header is not working not matter what type I use (e.g. application/vnd.sblistnegativetargetsresponse.v3.2+json ...)
Type of content
[X] Advanced tools center documentation
[ ] Amazon Ads API Postman collection
[ ] Other
Describe the solution you'd like
Add the Advertising API OpenAPI specification files to this repository.
Additional context
We use the published OpenAPI specification files to generate a library allowing us to easily communicate with the Advertising API. We currently must scour the documentation site to locate the JSON/YAML specification files to use in our build process. Providing a central location here to host these files would ease development of third-party libraries, prevent incomplete library code due to missing/missed specifications, and provide an account of changes to theses specifications. PR's could also be submitted to correct inaccuracies and incorrect definitions within the specification files themselves when encountered.
Amazon already provides the OpenAPI specification files for the Selling Partner API (selling-partner-api-models). It would be of great benefit to many if the same were provided for the Advertising API.
Thank you in advance...
Hi Amazon team,
I'm having troubles migrating our advertising api layer from v2 to v3. Basically, using the same credentials (clientId, refreshTokens and profileId), the new endpoint responses back with 401 auth error. I followed the documentation but I can't find any issues, shall I set something on the account before using the new versione?
Here's the working V2 snippet:
headers={ "Amazon-Advertising-API-ClientId": clientId, "Amazon-Advertising-API-Scope": profileId, "Authorization": accessToken, "Content-Type": "application/json" } data={ "stateFilter": "enabled", #"metrics": metrics, "metrics": ",".join([ "impressions","clicks","cost","campaignId","adGroupId" ]), "reportDate": "20221001" } response = re.post("https://advertising-api-eu.amazon.com/v2/sp/productAds/report", headers=headers, json=data) r = response.json()
And the not working V3 snippet:
`
headers = {
'Amazon-Advertising-API-ClientId': clientId,
'Amazon-Advertising-API-Scope': profileId,
'Authorization': accessToken,
'Content-Type': 'application/vnd.createasyncreportrequest.v3+json'
}
data = {
"name":"SP campaigns report 10/1-10/10",
"startDate":"2022-10-01",
"endDate":"2022-10-10",
"configuration":{
"adProduct":"SPONSORED_PRODUCTS",
"groupBy":["campaign","adGroup"],
"columns":["impressions","clicks","cost","campaignId","adGroupId","date"],
"reportTypeId":"spCampaigns",
"timeUnit":"DAILY",
"format":"GZIP_JSON"
}
}
response = requests.post('https://advertising-api.amazon.com/reporting/reports', headers=headers, data=data)
r = response.json()
`
Amazon provides keyword search API because I need an API endpoint that gives me volume and other related data for that keyword
Report Request:
curl --location 'https://advertising-api.amazon.com/v2/hsa/campaigns/report'
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.7e2dc1e5eee04eab99e84f84305ab44c'
--header 'Amazon-Advertising-API-Scope: 2368768247678785'
--header 'Content-Type: application/json'
--data '{
"reportDate":"20230501",
"metrics":"campaignId,campaignName,impressions,clicks,cost,attributedSales14d,attributedConversions14d,unitsSold14d"
}
Received ReportId:
{"reportId":"amzn1.clicksAPI.v1.p1.64770154.aba44b77-4e10-4086-bb16-82ef001968e7","recordType":"campaign","status":"IN_PROGRESS","statusDetails":"Report is being generated."}
Translation of the missing field:
The "unitsSold14d" field is missing from the downloaded data.
some of the response is:
{"unitsSold14d":0,"cost":0,"attributedConversions14d":0,"campaignId":144158449488730278,"clicks":0,"impressions":0,"attributedSales14d":0,"campaignName":"xxxx"},
{"cost":0,"attributedConversions14d":0,"campaignId":188030107477314,"clicks":0,"impressions":0,"attributedSales14d":0,"campaignName":"xxxxx"},
Create: SB Campaign.
2nd Step - Keyword Entity
Duplicate Rows:
As I understand, the last row should be "Creative Type*".
If applicable, add screenshots to help explain your problem.
When I do the creation of an advertising campaign:
body=[{'portfolioId': 0, 'name': '测试', 'campaignType': 'sponsoredProducts', 'targetingType': 'manual', 'state': 'paused', 'dailyBudget': 2.0, 'startDate': '20220830', 'premiumBidAdjustment': True, 'bidding': {'strategy': 'legacyForSales', 'adjustments': [{'predicate': 'placementTop', 'percentage': 0}]}}]
But it returns the error message:
[{'code': 'INVALID_ARGUMENT', 'description': "Either 'premiumBidAdjustment' or enhanced bidding controls should be specified, but not both."}]
Is there any way to obtain hourly level reports by creating v3 reports for SP or v2 reports for SB or SD types? I think the backend supports this
/managerAccounts this endpoint return max 50 linked accounts, but we have more
If you need help troubleshooting a problem with the Amazon Ads API, visit the Amazon Ads API service desk. Issues are for reporting documentation bugs and requesting enhancements only.
Describe the bug
In the Valid keyword characters, the character é
appeared twice.
URL of the content
https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#valid-keyword-characters
Description of what the documentation currently says
the character é
appeared twice.
Description of what the documentation should say
Not sure, keep only one é
, or the second é
may be a typo error.
Additional context
Describe the bug
One of the sample curl statements is incomplete and there are some typos in the statement too.
URL of the content
https://advertising.amazon.com/API/docs/en-us/amazon-marketing-stream/managing-subscriptions#sample
Description of what the documentation currently says
curl —location —request GET '/streams/subscriptions?maxResults=10'\
--header'Amazon-Advertising-API-ClientId: xxxxxxxxx' \
--header'Amazon-Advertising-API-Scope: xxxxxxxx' \
Description of what the documentation should say
curl --location --request GET 'https://advertising-api.amazon.com/streams/subscriptions?maxResults=10' \
--header 'Amazon-Advertising-API-ClientId: xxxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxx'
Additional context
I don't know anymore if every change i made was necessary, but it was working in the end.
Describe the bug
There's a typo either in the documentation of the API or in the implementation.
The OpenAPI spec path examples show that errors have this shape, with a "detail" key. This is consistent with the actual API response
"value": {
"code": "400",
"detail": "Invalid Advertiser or Marketplace ID."
}
In the same spec however, the schema says that AsyncReportingError has a "details" key
"properties": {
"code": {
"description": "The HTTP status code of the response.",
"type": "string"
},
"details": {
"description": "A human-readable description of the response.",
"type": "string"
}
}
In the documentation website it also pluralizes the "detail" key:
code string
The HTTP status code of the response.
details string
A human-readable description of the response.
URL of the content
OpenAPI spec: https://dtrnk0o2zy01c.cloudfront.net/openapi/en-us/dest/OfflineReport_prod_3p.json
Documentation: https://advertising.amazon.com/API/docs/en-us/offline-report-prod-3p#/Asynchronous%20Reports/getAsyncReport
Description of what the documentation currently says
code string
The HTTP status code of the response.
details string
A human-readable description of the response.
Description of what the documentation should say
code string
The HTTP status code of the response.
detail string
A human-readable description of the response.
Additional context
This also seems to apply to the response of successful DELETE requests
Hello,
I'm migrating from v2 to v3 and I was able to successfully generate the Advertised product reports but I noticed that the report did not include paused campaigns. Then I checked the documentation here and figured I could use the campaignStatus
filter to include paused campaigns, but then I got this error:
configuration filters includes fields: (campaignStatus) which are invalid for groupBys: advertiser.
Allowed filters for groupBy advertiser: (field: adCreativeStatus, values: ENABLED, PAUSED, 'ARCHIVED)
Then I tried using the adCreativeStatus
filter, it successfully generated the report but didn't include paused campaigns either.
Seems like a bug to me, but if not, how can I include paused campaigns in the report?
Type of content
[X] Advanced tools center documentation
Describe the solution you'd like
In the Developer Notes section on Object IDs, it states that IDs are unique for each type. I understand that it means that if I have an adId
, I can be sure that no other ad has the same ID, though an adGroup
or campaign
could.
What is a drop ambiguous is if these are unique globally, or only per ad product. Meaning, can a Sponsored Brands ad have the same adId
as a Sponsored Products ad?
Describe the bug
can not get currency from keywords sponsored brands report by using version2 report api
URL of the content
https://advertising.amazon.com/API/docs/en-us/reporting/v2/report-types#keyword-reports
Description of what the documentation currently says
Additional context
Add any other context about the problem here.
In the Data guide of the Amazon Marketing Stream for the sp-conversion fields for the dataset_id its written the value would be sp-traffic instead of sp-conversion.
URL of the content
Amazon Marketing Stream sp-conversion data docs
curl --location --request POST 'https://advertising-api.amazon.com/sp/campaigns/list'
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.20dxxxxxxx'
--header 'Authorization: Atxxxxxxx91zr'
--header 'Amazon-Advertising-API-Scope: 7128xxxxxxx'
--header 'Content-Type: application/vnd.spCampaign.v3+json'
--header 'Accept: application/vnd.spCampaign.v3+json'
--data-raw '{
"campaignIdFilter" : {
"include": ["1268xxxxx"]
}
}'
我通过这个接口的调用并没有返回extendedData 字段的值,我观测到sd目前有/extended这样的接口能拿到,那么sp类型的该如何获取呢?我非常需要这个字段里的值
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.