{ "info": { "_postman_id": "2b05ecc8-8fbf-49d2-b21c-bd51fabd4d53", "name": "Amazon Ads API Copy 2", "description": "# Amazon Ads API Postman collection\n\nThis collection includes commonly used endpoints for the Amazon Ads API. The collection also includes pre- and post-request scripts to automate management of auth credentials.\n\nVisit the [Amazon Ads advanced tools center](https://advertising.amazon.com/API/docs/en-us/) for API documentation.\n\n## Setup\n\nTo use this collection, you will need credentials for the Amazon Ads API. For information about acquiring credentials, see the [onboarding overview for the Amazon Ads API](https://advertising.amazon.com/API/docs/en-us/onboarding/overview).\n\nFind setup instructions in the Amazon Ads advanced tools center for:\n\n- [New users of the Amazon Ads API](https://advertising.amazon.com/API/docs/en-us/getting-started/using-postman-collection)\n- [Users with an existing refresh token](https://advertising.amazon.com/API/docs/en-us/tutorials/postman) \n\n## Issues and support\n\nFor technical support for the Amazon Ads API, see [Technical support](https://advertising.amazon.com/API/docs/en-us/info/support) in the Amazon Ads advanced tools center.\n\nTo report a bug or suggest an improvement relating to this collection or the documentation, [create an issue](https://github.com/amzn/ads-advanced-tools-docs/issues/new/choose).", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", "_exporter_id": "25489918" }, "item": [ { "name": "Auth", "item": [ { "name": "Auth grant login", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should return form login page\", function () {", " pm.response.to.not.be.error;", "});", "", "console.log(`Authorization grant URL: \\n${pm.environment.get('auth_grant_url')}?scope=${pm.environment.get('permission_scope')}&response_type=code&client_id=${pm.environment.get('client_id')}&state=State&redirect_uri=${pm.environment.get('redirect_uri')}\\n`)" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "const jar = pm.cookies.jar()", "", "jar.clear(pm.request.url, function (error) {", " ", "})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{auth_grant_url}}?scope={{permission_scope}}&response_type=code&client_id={{client_id}}&state=State&redirect_uri={{redirect_uri}}", "host": [ "{{auth_grant_url}}" ], "query": [ { "key": "scope", "value": "{{permission_scope}}" }, { "key": "response_type", "value": "code" }, { "key": "client_id", "value": "{{client_id}}" }, { "key": "state", "value": "State" }, { "key": "redirect_uri", "value": "{{redirect_uri}}" } ] }, "description": "[Learn more about authorization grants.](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/authorization-grants)" }, "response": [] }, { "name": "Access token from auth grant code", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "// The following script sets Postman environment variables to enable authorization for subsequent requests to the Amazon Ads API. Token freshness for subsequent requests is handled by a collection-level pre-request script. ", "// See collection documentation for setup information. ", "// For information about retrieving access tokens for the Amazon Ads API, see https://advertising.amazon.com/API/docs/en-us/concepts/authorization/access-tokens#retrieving-access-tokens", "", "const res = JSON.parse(responseBody);", "if (res.access_token && res.refresh_token) {", " postman.setEnvironmentVariable(\"access_token\", res.access_token);", " postman.setEnvironmentVariable(\"refresh_token\", res.refresh_token);", " postman.setEnvironmentVariable(\"token_expires_at\", Date.now() + (res.expires_in * 1000) - 10000)", "} else {", " console.log('Authorization failed.')", " console.log(res)", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "authorization_code", "type": "text" }, { "key": "code", "value": "", "description": "An authorization code retrieved via Login with Amazon's authorization grant process.", "type": "text" }, { "key": "redirect_uri", "value": "{{redirect_uri}}", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": "{{token_url}}", "description": "[Learn more about access tokens.](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/access-tokens)" }, "response": [] }, { "name": "Access token from refresh token", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "// The following script sets Postman environment variables to enable authorization for subsequent requests to the Amazon Ads API. ", "// NOTE: This request is included for reference, but may not need to be run to use this collection -- token freshness is typically handled by a collection-level pre-request script. ", "// See collection documentation for setup information. ", "// For information about retrieving access tokens for the Amazon Ads API, see https://advertising.amazon.com/API/docs/en-us/concepts/authorization/access-tokens#retrieving-access-tokens", "", "const res = JSON.parse(responseBody);", "if (res.access_token && res.refresh_token) {", " postman.setEnvironmentVariable(\"access_token\", res.access_token);", " postman.setEnvironmentVariable(\"refresh_token\", res.refresh_token);", " postman.setEnvironmentVariable(\"token_expires_at\", Date.now() + (res.expires_in * 1000) - 10000)", "} else {", " console.log('Authorization failed.')", " console.log(res)", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "refresh_token", "type": "text" }, { "key": "refresh_token", "value": "{{refresh_token}}", "type": "text" }, { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" } ] }, "url": "{{token_url}}" }, "response": [] } ], "description": "Authorization credentials for the Amazon Ads API are administered by Login with Amazon. The requests in the **Auth** folder are directed to Login with Amazon hosts rather than to the host specified for other requests to the API.\n\nLearn more about [Authorization in the Amazon Ads API](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/overview).\n\n[Follow the Postman quickstart guide](https://advertising.amazon.com/API/docs/en-us/getting-started/using-postman-collection) to learn about using the requests in this folder.\n\n## Using tokens in this collection\n\nOnce you have retrieved a refresh token, a pre-request script in this collection will refresh your access token automatically as needed." }, { "name": "Accounts", "item": [ { "name": "Profiles", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "// This script sets the profileId that is used in the \"Amazon-Advertising-API-Scope\" header for subsequent calls to the Amazon Ads API. This header determines the marketplace in which the requested operation will be carried out. ", "// By default, the *first* profile retrieved is used for this script.", "// To use another profile, select the profileId for the appropriate account in the response body, then manually set profileId in the Postman environment to the desired value. To preserve the desired value, disable the script below or simply do not execute this request again.", "// For more information on profiles in the Amazon Ads API, see https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles", "", "const res = JSON.parse(responseBody);", "", "// if any profiles are retrieved, set profileId in environment to first profile retrieved", "if (res.length) {", " postman.setEnvironmentVariable(\"profileId\", res[0].profileId)", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": "{{api_url}}/v2/profiles", "description": "[Read full documentation.](https://advertising.amazon.com/API/docs/en-us/reference/2/profiles)" }, "response": [] }, { "name": "Manager accounts", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": "{{api_url}}/managerAccounts", "description": "[Read full documentation.](https://advertising.amazon.com/API/docs/en-us/reference/1-0/managerAccount)" }, "response": [] } ], "description": "## Profiles\n\nProfiles in the Amazon Ads API represent an advertiser's account in a specific marketplace. Advertisers may have a single profile if they advertise in only one marketplace, or a separate profile for *each* marketplace if they advertise regionally or globally.\n\nProfiles play a crucial role in the Amazon Ads API by determining the management scope for most requests. A profile ID is a required credential to access an advertiser's data and services in a specific marketplace.\n\n[Learn more about profiles.](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles)\n\n## Using profiles in this collection\n\nThe **`GET`** **Profiles** request retrieves a list of all profiles within the API host's region that are associated with the advertiser whose permission is represented by the access token.\n\nBy default, a post-request script sets the `profileId` in your Postman environment to the ID of the *first* profile retrieved. This value is used as the `Amazon-Advertising-API-Scope` header in all other requests.\n\nTo use a different profile ID, copy a `profileId` from a retrieved profile and use it to set the `profileId` variable in the Postman environment.\n\n## Manager accounts\n\nManager accounts can manage multiple advertising accounts through a single user account.\n\n[Learn more about manager accounts in the Amazon Ads console.](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120&entityId=ENTITY3GRDJT8FAN4KG#GU3YDB26FR7XT3C8)\n\nA manager account can retrieve profiles for its linked accounts via the **`GET`** **Profiles** request.\n\nThe **`GET`** **Manager accounts** request returns additional information about linked accounts, including the `dspAdvertiserId` for DSP advertisers." }, { "name": "First call", "item": [ { "name": "List SB campaigns", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "url": "{{api_url}}/sb/v4/campaigns/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "url": "{{api_url}}/sb/v4/campaigns/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 28 Mar 2023 19:10:37 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "641" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "X6SM1M6EFDN44C60NQC9" }, { "key": "x-amzn-RequestId", "value": "e1bab0ca-bf73-43c7-a7dc-02b1ad625770" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "28358208-795d-4ee6-8a2f-755335addec5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "641" }, { "key": "x-amz-apigw-id", "value": "CgZDJEtnoAMFzbA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64233bad-d65ff4f637ef95198ccb4e1c" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 28 Mar 2023 19:10:36 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": [\n {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY21DWFJV45CH71\",\n \"budget\": 50,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"38789817437281\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Campaign - 2/20/2023 22:26:18\",\n \"startDate\": \"2023-02-20\",\n \"state\": \"ENABLED\"\n },\n {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY21DWFJV45CH71\",\n \"budget\": 100,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"194584775574615\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Campaign - 3/8/2023 16:39:05\",\n \"startDate\": \"2023-03-08\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalCount\": 2\n}" } ] }, { "name": "List SD campaigns", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/campaigns" }, "response": [ { "name": "Multiple campaigns", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/campaigns" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 28 Apr 2022 18:59:48 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "F710X7RQF00MSPPY8J76" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "[\n {\n \"campaignId\": 127519806194475,\n \"name\": \"SdTestCampaign-26/01/2022 15:37:31\",\n \"tactic\": \"T00020\",\n \"startDate\": \"20220126\",\n \"state\": \"enabled\",\n \"costType\": \"cpc\",\n \"budget\": 100,\n \"budgetType\": \"daily\",\n \"deliveryProfile\": \"as_soon_as_possible\"\n },\n {\n \"campaignId\": 7283550165182,\n \"name\": \"SdTestCampaign-26/01/2022 15:38:51\",\n \"tactic\": \"T00020\",\n \"startDate\": \"20220126\",\n \"state\": \"enabled\",\n \"costType\": \"cpc\",\n \"budget\": 100,\n \"budgetType\": \"daily\",\n \"deliveryProfile\": \"as_soon_as_possible\"\n }\n]" } ] }, { "name": "List SP campaigns", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save campaignId for first object to environemnt*/", "var response = JSON.parse(responseBody);", "var campaignId = response.campaigns[0].campaignId", "postman.clearEnvironmentVariable(\"campaignId\");", "postman.setEnvironmentVariable(\"campaignId\", campaignId);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "url": "{{api_url}}/sp/campaigns/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "url": "{{api_url}}/sp/campaigns/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 01 Nov 2022 15:02:19 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "998" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "5HEKN21BJJQSJABDZRG8" }, { "key": "x-amzn-RequestId", "value": "db123bd2-fbbf-4776-9f89-762f804e4fd2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "540e834b-ccd1-4cc5-9331-a3fae8bfcc8b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "998" }, { "key": "x-amz-apigw-id", "value": "a7U3PFNKoAMF2Uw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-636134fb-8eeea990f0c22270dfedd2de" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 01 Nov 2022 15:02:18 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": [\n {\n \"budget\": {\n \"budget\": 15,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"52978233888897\",\n \"dynamicBidding\": {\n \"placementBidding\": [],\n \"strategy\": \"AUTO_FOR_SALES\"\n },\n \"name\": \"Campaign - 8/11/2022 11:28:51\",\n \"premiumBidAdjustment\": false,\n \"startDate\": \"2022-08-11\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"AUTO\"\n },\n {\n \"budget\": {\n \"budget\": 100,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"276748589410145\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"endDate\": \"2022-11-08\",\n \"name\": \"Test SP campaign\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-10-31\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"AUTO\"\n },\n {\n \"budget\": {\n \"budget\": 100,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"62077673972552\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 50,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"AUTO_FOR_SALES\"\n },\n \"name\": \"SpTestCampaign-11/08/2022 15:32:07#l6p7828r590\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-08-11\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"MANUAL\"\n }\n ],\n \"totalResults\": 3\n}" } ] } ] }, { "name": "Reporting", "item": [ { "name": "DSP report", "item": [ { "name": "Request DSP report", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"response should return reportId\", function () {", " pm.response.to.not.be.error;", "});", "", "/**Sets the returned reportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"reportId\");", "var response = JSON.parse(responseBody);", "", "if (response) {", " postman.setEnvironmentVariable(\"reportId\", response.reportId);", " console.log('reportId = ' + pm.environment.get(\"reportId\"));", "}", "else {", " console.log('Error requesting report with error = ' + response.description);", "}", "", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true, "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2023-02-21\",\n \"endDate\": \"2023-02-27\",\n \"type\": \"CAMPAIGN\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\",\n \"CREATIVE\"\n ],\n \"metrics\": [\n \"3pFeeAutomotive\",\n \"3pFeeAutomotiveAbsorbed\",\n \"3pFeeComScore\",\n \"3pFeeComScoreAbsorbed\",\n \"3pFeeCPM1\",\n \"3pFeeCPM1Absorbed\",\n \"3pFeeCPM2\",\n \"3pFeeCPM2Absorbed\",\n \"3pFeeCPM3\",\n \"3pFeeCPM3Absorbed\",\n \"3pFeeDoubleclickCampaignManager\",\n \"3pFeeDoubleclickCampaignManagerAbsorbed\",\n \"3pFeeDoubleVerify\",\n \"3pFeeDoubleVerifyAbsorbed\",\n \"3pFeeIntegralAdScience\",\n \"3pFeeIntegralAdScienceAbsorbed\",\n \"3PFees\",\n \"accept14d\",\n \"acceptClicks14d\",\n \"acceptCPA14d\",\n \"acceptCVR14d\",\n \"acceptViews14d\",\n \"addedToShoppingCart14d\",\n \"addedToShoppingCartClicks14d\",\n \"addedToShoppingCartCPA14d\",\n \"addedToShoppingCartCVR14d\",\n \"addedToShoppingCartViews14d\",\n \"addToWatchlist14d\",\n \"addToWatchlistClicks14d\",\n \"addToWatchlistCPA14d\",\n \"addToWatchlistCVR14d\",\n \"addToWatchlistViews14d\",\n \"advertiserCountry\",\n \"advertiserTimezone\",\n \"agencyFee\",\n \"amazonAudienceFee\",\n \"amazonPlatformFee\",\n \"application14d\",\n \"applicationClicks14d\",\n \"applicationCPA14d\",\n \"applicationCVR14d\",\n \"applicationViews14d\",\n \"atc14d\",\n \"atcClicks14d\",\n \"atcr14d\",\n \"atcViews14d\",\n \"atl14d\",\n \"atlClicks14d\",\n \"atlr14d\",\n \"atlViews14d\",\n \"bannerInteraction14d\",\n \"bannerInteractionClicks14d\",\n \"bannerInteractionCPA14d\",\n \"bannerInteractionCVR14d\",\n \"bannerInteractionViews14d\",\n \"brandSearch14d\",\n \"brandSearchClicks14d\",\n \"brandSearchCPA14d\",\n \"brandSearchRate14d\",\n \"brandSearchViews14d\",\n \"brandStoreEngagement1\",\n \"brandStoreEngagement1Clicks\",\n \"brandStoreEngagement1CPA\",\n \"brandStoreEngagement1CVR\",\n \"brandStoreEngagement1Views\",\n \"brandStoreEngagement2\",\n \"brandStoreEngagement2Clicks\",\n \"brandStoreEngagement2CPA\",\n \"brandStoreEngagement2CVR\",\n \"brandStoreEngagement2Views\",\n \"brandStoreEngagement3\",\n \"brandStoreEngagement3Clicks\",\n \"brandStoreEngagement3CPA\",\n \"brandStoreEngagement3CVR\",\n \"brandStoreEngagement3Views\",\n \"brandStoreEngagement4\",\n \"brandStoreEngagement4Clicks\",\n \"brandStoreEngagement4CPA\",\n \"brandStoreEngagement4CVR\",\n \"brandStoreEngagement4Views\",\n \"brandStoreEngagement5\",\n \"brandStoreEngagement5Clicks\",\n \"brandStoreEngagement5CPA\",\n \"brandStoreEngagement5CVR\",\n \"brandStoreEngagement5Views\",\n \"brandStoreEngagement6\",\n \"brandStoreEngagement6Clicks\",\n \"brandStoreEngagement6CPA\",\n \"brandStoreEngagement6CVR\",\n \"brandStoreEngagement6Views\",\n \"brandStoreEngagement7\",\n \"brandStoreEngagement7Clicks\",\n \"brandStoreEngagement7CPA\",\n \"brandStoreEngagement7CVR\",\n \"brandStoreEngagement7Views\",\n \"clickOnRedirect14d\",\n \"clickOnRedirectClicks14d\",\n \"clickOnRedirectCPA14d\",\n \"clickOnRedirectCVR14d\",\n \"clickOnRedirectViews14d\",\n \"clickThroughs\",\n \"combinedECPP\",\n \"combinedERPM\",\n \"combinedProductSales\",\n \"combinedPurchaseRate\",\n \"combinedPurchases\",\n \"combinedPurchasesClicks\",\n \"combinedPurchasesViews\",\n \"combinedROAS\",\n \"combinedUnitsSold\",\n \"CTR\",\n \"decline14d\",\n \"declineClicks14d\",\n \"declineCPA14d\",\n \"declineCVR14d\",\n \"declineViews14d\",\n \"downloadedVideoPlayRate14d\",\n \"downloadedVideoPlays14d\",\n \"downloadedVideoPlaysClicks14d\",\n \"downloadedVideoPlaysViews14d\",\n \"dpv14d\",\n \"dpvClicks14d\",\n \"dpvr14d\",\n \"dpvViews14d\",\n \"dropDownSelection14d\",\n \"dropDownSelectionClicks14d\",\n \"dropDownSelectionCPA14d\",\n \"dropDownSelectionCVR14d\",\n \"dropDownSelectionViews14d\",\n \"eCPAtc14d\",\n \"eCPAtl14d\",\n \"eCPC\",\n \"eCPDPV14d\",\n \"eCPDVP14d\",\n \"eCPM\",\n \"eCPnewSubscribeAndSave14d\",\n \"eCPP14d\",\n \"eCPPRPV14d\",\n \"eCPPT14d\",\n \"ecpr14d\",\n \"ecpvc\",\n \"ecpvd14d\",\n \"eCPVS14d\",\n \"emailInteraction14d\",\n \"emailInteractionClicks14d\",\n \"emailInteractionCPA14d\",\n \"emailInteractionCVR14d\",\n \"emailInteractionViews14d\",\n \"emailLoad14d\",\n \"emailLoadClicks14d\",\n \"emailLoadCPA14d\",\n \"emailLoadCVR14d\",\n \"emailLoadViews14d\",\n \"eRPM14d\",\n \"gameInteraction14d\",\n \"gameInteractionClicks14d\",\n \"gameInteractionCPA14d\",\n \"gameInteractionCVR14d\",\n \"gameInteractionViews14d\",\n \"gameLoad14d\",\n \"gameLoadClicks14d\",\n \"gameLoadCPA14d\",\n \"gameLoadCVR14d\",\n \"gameLoadViews14d\",\n \"grossClickThroughs\",\n \"grossImpressions\",\n \"homepageVisit14d\",\n \"homepageVisitClicks14d\",\n \"homepageVisitCPA14d\",\n \"homepageVisitCVR14d\",\n \"homepageVisitViews14d\",\n \"impressions\",\n \"invalidClickThroughs\",\n \"invalidClickThroughsRate\",\n \"invalidImpressionRate\",\n \"invalidImpressions\",\n \"marketingLandingPage14d\",\n \"marketingLandingPageClicks14d\",\n \"marketingLandingPageCPA14d\",\n \"marketingLandingPageCVR14d\",\n \"marketingLandingPageViews14d\",\n \"mashupAddToCart14d\",\n \"mashupAddToCartClickCVR14d\",\n \"mashupAddToCartClicks14d\",\n \"mashupAddToCartCPA14d\",\n \"mashupAddToCartViews14d\",\n \"mashupAddToWishlist14d\",\n \"mashupAddToWishlistClicks14d\",\n \"mashupAddToWishlistCPA14d\",\n \"mashupAddToWishlistCVR14d\",\n \"mashupAddToWishlistViews14d\",\n \"mashupBackupImage\",\n \"mashupBackupImageClicks\",\n \"mashupBackupImageCPA\",\n \"mashupBackupImageCVR\",\n \"mashupBackupImageViews\",\n \"mashupClickToPage\",\n \"mashupClickToPageClicks\",\n \"mashupClickToPageCPA\",\n \"mashupClickToPageCVR\",\n \"mashupClickToPageViews\",\n \"mashupClipCouponClick14d\",\n \"mashupClipCouponClickClicks14d\",\n \"mashupClipCouponClickCPA14d\",\n \"mashupClipCouponClickCVR14d\",\n \"mashupClipCouponClickViews14d\",\n \"mashupShopNowClick14d\",\n \"mashupShopNowClickClicks14d\",\n \"mashupShopNowClickCPA14d\",\n \"mashupShopNowClickCVR14d\",\n \"mashupShopNowClickViews14d\",\n \"mashupSubscribeAndSave14d\",\n \"mashupSubscribeAndSaveClick14d\",\n \"mashupSubscribeAndSaveClickViews14d\",\n \"mashupSubscribeAndSaveCPA14d\",\n \"mashupSubscribeAndSaveCVR14d\",\n \"measurableImpressions\",\n \"measurableRate\",\n \"messageSent14d\",\n \"messageSentClicks14d\",\n \"messageSentCPA14d\",\n \"messageSentCVR14d\",\n \"messageSentViews14d\",\n \"mobileAppFirstStartClicks14d\",\n \"mobileAppFirstStartCVR14d\",\n \"mobileAppFirstStarts14d\",\n \"mobileAppFirstStartsCPA14d\",\n \"mobileAppFirstStartViews14d\",\n \"newSubscribeAndSave14d\",\n \"newSubscribeAndSaveClicks14d\",\n \"newSubscribeAndSaveRate14d\",\n \"newSubscribeAndSaveViews14d\",\n \"newToBrandECPP14d\",\n \"newToBrandERPM14d\",\n \"newToBrandProductSales14d\",\n \"newToBrandPurchaseRate14d\",\n \"newToBrandPurchases14d\",\n \"newToBrandPurchasesClicks14d\",\n \"newToBrandPurchasesViews14d\",\n \"newToBrandROAS14d\",\n \"newToBrandUnitsSold14d\",\n \"offAmazonClicks14d\",\n \"offAmazonConversions14d\",\n \"offAmazonCPA14d\",\n \"offAmazonCVR14d\",\n \"offAmazonECPP14d\",\n \"offAmazonERPM14d\",\n \"offAmazonProductSales14d\",\n \"offAmazonPurchaseRate14d\",\n \"offAmazonPurchases14d\",\n \"offAmazonPurchasesClicks14d\",\n \"offAmazonPurchasesViews14d\",\n \"offAmazonROAS14d\",\n \"offAmazonUnitsSold14d\",\n \"offAmazonViews14d\",\n \"percentOfPurchasesNewToBrand14d\",\n \"playerTrailersClicks14d\",\n \"playTrailerRate14d\",\n \"playTrailers14d\",\n \"playTrailersViews14d\",\n \"pRPV14d\",\n \"pRPVClicks14d\",\n \"pRPVr14d\",\n \"pRPVViews14d\",\n \"purchaseButton14d\",\n \"purchaseButtonClicks14d\",\n \"purchaseButtonCPA14d\",\n \"purchaseButtonCVR14d\",\n \"purchaseButtonViews14d\",\n \"purchaseRate14d\",\n \"purchases14d\",\n \"purchasesClicks14d\",\n \"purchasesViews14d\",\n \"referral14d\",\n \"referralClicks14d\",\n \"referralCPA14d\",\n \"referralCVR14d\",\n \"referralViews14d\",\n \"registrationConfirmPage14d\",\n \"registrationConfirmPageClicks14d\",\n \"registrationConfirmPageCPA14d\",\n \"registrationConfirmPageCVR14d\",\n \"registrationConfirmPageViews14d\",\n \"registrationForm14d\",\n \"registrationFormClicks14d\",\n \"registrationFormCPA14d\",\n \"registrationFormCVR14d\",\n \"registrationFormViews14d\",\n \"rentalRate14d\",\n \"rentals14d\",\n \"rentalsClicks14d\",\n \"rentalsViews14d\",\n \"ROAS14d\",\n \"sales14d\",\n \"signUp14d\",\n \"signUpClicks14d\",\n \"signUpCPA14d\",\n \"signUpCVR14d\",\n \"signUpPage14d\",\n \"signUpPageClicks14d\",\n \"signUpPageCPA14d\",\n \"signUpPageCVR14d\",\n \"signUpPageViews14d\",\n \"signUpViews14d\",\n \"storeLocatorPage14d\",\n \"storeLocatorPageClicks14d\",\n \"storeLocatorPageCPA14d\",\n \"storeLocatorPageCVR14d\",\n \"storeLocatorPageViews14d\",\n \"submitButton14d\",\n \"submitButtonClicks14d\",\n \"submitButtonCPA14d\",\n \"submitButtonCVR14d\",\n \"submitButtonViews14d\",\n \"subscribe14d\",\n \"subscribeClicks14d\",\n \"subscribeCPA14d\",\n \"subscribeCVR14d\",\n \"subscribeViews14d\",\n \"subscriptionButton14d\",\n \"subscriptionButtonClicks14d\",\n \"subscriptionButtonCPA14d\",\n \"subscriptionButtonCVR14d\",\n \"subscriptionButtonViews14d\",\n \"successPage14d\",\n \"successPageClicks14d\",\n \"successPageCPA14d\",\n \"successPageCVR14d\",\n \"successPageViews14d\",\n \"supplyCost\",\n \"surveyFinish14d\",\n \"surveyFinishClicks14d\",\n \"surveyFinishCPA14d\",\n \"surveyFinishCVR14d\",\n \"surveyFinishViews14d\",\n \"surveyStart14d\",\n \"surveyStartClicks14d\",\n \"surveyStartCPA14d\",\n \"surveyStartCVR14d\",\n \"surveyStartViews14d\",\n \"thankYouPage14d\",\n \"thankYouPageClicks14d\",\n \"thankYouPageCPA14d\",\n \"thankYouPageCVR14d\",\n \"thankYouPageViews14d\",\n \"totalAddToCart14d\",\n \"totalAddToCartClicks14d\",\n \"totalAddToCartCPA14d\",\n \"totalAddToCartCVR14d\",\n \"totalAddToCartViews14d\",\n \"totalAddToList14d\",\n \"totalAddToListClicks14d\",\n \"totalAddToListCPA14d\",\n \"totalAddToListCVR14d\",\n \"totalAddToListViews14d\",\n \"totalCost\",\n \"totalDetailPageClicks14d\",\n \"totalDetailPageViews14d\",\n \"totalDetailPageViewsCVR14d\",\n \"totalDetailPageViewViews14d\",\n \"totalDetaiPageViewCPA14d\",\n \"totalECPP14d\",\n \"totalECPPRPV14d\",\n \"totalERPM14d\",\n \"totalFee\",\n \"totalNewToBrandECPP14d\",\n \"totalNewToBrandERPM14d\",\n \"totalNewToBrandProductSales14d\",\n \"totalNewToBrandPurchaseRate14d\",\n \"totalNewToBrandPurchases14d\",\n \"totalNewToBrandPurchasesClicks14d\",\n \"totalNewToBrandPurchasesViews14d\",\n \"totalNewToBrandROAS14d\",\n \"totalNewToBrandUnitsSold14d\",\n \"totalPercentOfPurchasesNewToBrand14d\",\n \"totalPRPV14d\",\n \"totalPRPVClicks14d\",\n \"totalPRPVr14d\",\n \"totalPRPVViews14d\",\n \"totalPurchaseRate14d\",\n \"totalPurchases14d\",\n \"totalPurchasesClicks14d\",\n \"totalPurchasesViews14d\",\n \"totalROAS14d\",\n \"totalSales14d\",\n \"totalSubscribeAndSaveSubscriptionClicks14d\",\n \"totalSubscribeAndSaveSubscriptionCPA14d\",\n \"totalSubscribeAndSaveSubscriptionCVR14d\",\n \"totalSubscribeAndSaveSubscriptions14d\",\n \"totalSubscribeAndSaveSubscriptionViews14d\",\n \"totalUnitsSold14d\",\n \"unitsSold14d\",\n \"videoComplete\",\n \"videoCompleted\",\n \"videoCompletedCPA\",\n \"videoCompletedCVR\",\n \"videoCompletedViews\",\n \"videoCompletionRate\",\n \"videoDownloadRate14d\",\n \"videoDownloads14d\",\n \"videoDownloadsClicks14d\",\n \"videoDownloadsViews14d\",\n \"videoEndClicks\",\n \"videoFirstQuartile\",\n \"videoMidpoint\",\n \"videoMute\",\n \"videoPause\",\n \"videoResume\",\n \"videoStart\",\n \"videoStarted\",\n \"videoStartedClicks\",\n \"videoStartedCPA\",\n \"videoStartedCVR\",\n \"videoStartedViews\",\n \"videoStreams14d\",\n \"videoStreamsClicks14d\",\n \"videoStreamsRate14d\",\n \"videoStreamsViews14d\",\n \"videoThirdQuartile\",\n \"videoUnmute\",\n \"viewabilityRate\",\n \"viewableImpressions\",\n \"widgetInteraction14d\",\n \"widgetInteractionClicks14d\",\n \"widgetInteractionCPA14d\",\n \"widgetInteractionCVR14d\",\n \"widgetInteractionViews14d\",\n \"widgetLoad14d\",\n \"widgetLoadClicks14d\",\n \"widgetLoadCPA14d\",\n \"widgetLoadCVR14d\",\n \"widgetLoadViews14d\"\n ]\n}" }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "response": [ { "name": "Request DSP report", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2023-02-01\",\n \"endDate\": \"2023-02-03\"\n}" }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 25 May 2022 17:20:24 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "192" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "3XSAMY34795RVTDP0CC9" }, { "key": "x-amzn-RequestId", "value": "b5e50062-88cd-4286-af3f-3a2ed1667e4f" }, { "key": "x-amzn-Remapped-Content-Length", "value": "192" }, { "key": "x-amz-apigw-id", "value": "SsTFyHHIoAMFx4Q=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-628e6558-55cf7d19c8a0248034e055a6" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 25 May 2022 17:20:24 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"reportId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"CAMPAIGN\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-05-25T18:20:24.425Z\"\n}" }, { "name": "Campaign", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2023-02-21\",\n \"endDate\": \"2023-02-27\",\n \"type\": \"CAMPAIGN\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\",\n \"CREATIVE\"\n ],\n \"metrics\": [\n \"3pFeeAutomotive\",\n \"3pFeeAutomotiveAbsorbed\",\n \"3pFeeComScore\",\n \"3pFeeComScoreAbsorbed\",\n \"3pFeeCPM1\",\n \"3pFeeCPM1Absorbed\",\n \"3pFeeCPM2\",\n \"3pFeeCPM2Absorbed\",\n \"3pFeeCPM3\",\n \"3pFeeCPM3Absorbed\",\n \"3pFeeDoubleclickCampaignManager\",\n \"3pFeeDoubleclickCampaignManagerAbsorbed\",\n \"3pFeeDoubleVerify\",\n \"3pFeeDoubleVerifyAbsorbed\",\n \"3pFeeIntegralAdScience\",\n \"3pFeeIntegralAdScienceAbsorbed\",\n \"3PFees\",\n \"accept14d\",\n \"acceptClicks14d\",\n \"acceptCPA14d\",\n \"acceptCVR14d\",\n \"acceptViews14d\",\n \"addedToShoppingCart14d\",\n \"addedToShoppingCartClicks14d\",\n \"addedToShoppingCartCPA14d\",\n \"addedToShoppingCartCVR14d\",\n \"addedToShoppingCartViews14d\",\n \"addToWatchlist14d\",\n \"addToWatchlistClicks14d\",\n \"addToWatchlistCPA14d\",\n \"addToWatchlistCVR14d\",\n \"addToWatchlistViews14d\",\n \"advertiserCountry\",\n \"advertiserTimezone\",\n \"agencyFee\",\n \"amazonAudienceFee\",\n \"amazonPlatformFee\",\n \"application14d\",\n \"applicationClicks14d\",\n \"applicationCPA14d\",\n \"applicationCVR14d\",\n \"applicationViews14d\",\n \"atc14d\",\n \"atcClicks14d\",\n \"atcr14d\",\n \"atcViews14d\",\n \"atl14d\",\n \"atlClicks14d\",\n \"atlr14d\",\n \"atlViews14d\",\n \"bannerInteraction14d\",\n \"bannerInteractionClicks14d\",\n \"bannerInteractionCPA14d\",\n \"bannerInteractionCVR14d\",\n \"bannerInteractionViews14d\",\n \"brandSearch14d\",\n \"brandSearchClicks14d\",\n \"brandSearchCPA14d\",\n \"brandSearchRate14d\",\n \"brandSearchViews14d\",\n \"brandStoreEngagement1\",\n \"brandStoreEngagement1Clicks\",\n \"brandStoreEngagement1CPA\",\n \"brandStoreEngagement1CVR\",\n \"brandStoreEngagement1Views\",\n \"brandStoreEngagement2\",\n \"brandStoreEngagement2Clicks\",\n \"brandStoreEngagement2CPA\",\n \"brandStoreEngagement2CVR\",\n \"brandStoreEngagement2Views\",\n \"brandStoreEngagement3\",\n \"brandStoreEngagement3Clicks\",\n \"brandStoreEngagement3CPA\",\n \"brandStoreEngagement3CVR\",\n \"brandStoreEngagement3Views\",\n \"brandStoreEngagement4\",\n \"brandStoreEngagement4Clicks\",\n \"brandStoreEngagement4CPA\",\n \"brandStoreEngagement4CVR\",\n \"brandStoreEngagement4Views\",\n \"brandStoreEngagement5\",\n \"brandStoreEngagement5Clicks\",\n \"brandStoreEngagement5CPA\",\n \"brandStoreEngagement5CVR\",\n \"brandStoreEngagement5Views\",\n \"brandStoreEngagement6\",\n \"brandStoreEngagement6Clicks\",\n \"brandStoreEngagement6CPA\",\n \"brandStoreEngagement6CVR\",\n \"brandStoreEngagement6Views\",\n \"brandStoreEngagement7\",\n \"brandStoreEngagement7Clicks\",\n \"brandStoreEngagement7CPA\",\n \"brandStoreEngagement7CVR\",\n \"brandStoreEngagement7Views\",\n \"clickOnRedirect14d\",\n \"clickOnRedirectClicks14d\",\n \"clickOnRedirectCPA14d\",\n \"clickOnRedirectCVR14d\",\n \"clickOnRedirectViews14d\",\n \"clickThroughs\",\n \"combinedECPP\",\n \"combinedERPM\",\n \"combinedProductSales\",\n \"combinedPurchaseRate\",\n \"combinedPurchases\",\n \"combinedPurchasesClicks\",\n \"combinedPurchasesViews\",\n \"combinedROAS\",\n \"combinedUnitsSold\",\n \"CTR\",\n \"decline14d\",\n \"declineClicks14d\",\n \"declineCPA14d\",\n \"declineCVR14d\",\n \"declineViews14d\",\n \"downloadedVideoPlayRate14d\",\n \"downloadedVideoPlays14d\",\n \"downloadedVideoPlaysClicks14d\",\n \"downloadedVideoPlaysViews14d\",\n \"dpv14d\",\n \"dpvClicks14d\",\n \"dpvr14d\",\n \"dpvViews14d\",\n \"dropDownSelection14d\",\n \"dropDownSelectionClicks14d\",\n \"dropDownSelectionCPA14d\",\n \"dropDownSelectionCVR14d\",\n \"dropDownSelectionViews14d\",\n \"eCPAtc14d\",\n \"eCPAtl14d\",\n \"eCPC\",\n \"eCPDPV14d\",\n \"eCPDVP14d\",\n \"eCPM\",\n \"eCPnewSubscribeAndSave14d\",\n \"eCPP14d\",\n \"eCPPRPV14d\",\n \"eCPPT14d\",\n \"ecpr14d\",\n \"ecpvc\",\n \"ecpvd14d\",\n \"eCPVS14d\",\n \"emailInteraction14d\",\n \"emailInteractionClicks14d\",\n \"emailInteractionCPA14d\",\n \"emailInteractionCVR14d\",\n \"emailInteractionViews14d\",\n \"emailLoad14d\",\n \"emailLoadClicks14d\",\n \"emailLoadCPA14d\",\n \"emailLoadCVR14d\",\n \"emailLoadViews14d\",\n \"eRPM14d\",\n \"gameInteraction14d\",\n \"gameInteractionClicks14d\",\n \"gameInteractionCPA14d\",\n \"gameInteractionCVR14d\",\n \"gameInteractionViews14d\",\n \"gameLoad14d\",\n \"gameLoadClicks14d\",\n \"gameLoadCPA14d\",\n \"gameLoadCVR14d\",\n \"gameLoadViews14d\",\n \"grossClickThroughs\",\n \"grossImpressions\",\n \"homepageVisit14d\",\n \"homepageVisitClicks14d\",\n \"homepageVisitCPA14d\",\n \"homepageVisitCVR14d\",\n \"homepageVisitViews14d\",\n \"impressions\",\n \"invalidClickThroughs\",\n \"invalidClickThroughsRate\",\n \"invalidImpressionRate\",\n \"invalidImpressions\",\n \"marketingLandingPage14d\",\n \"marketingLandingPageClicks14d\",\n \"marketingLandingPageCPA14d\",\n \"marketingLandingPageCVR14d\",\n \"marketingLandingPageViews14d\",\n \"mashupAddToCart14d\",\n \"mashupAddToCartClickCVR14d\",\n \"mashupAddToCartClicks14d\",\n \"mashupAddToCartCPA14d\",\n \"mashupAddToCartViews14d\",\n \"mashupAddToWishlist14d\",\n \"mashupAddToWishlistClicks14d\",\n \"mashupAddToWishlistCPA14d\",\n \"mashupAddToWishlistCVR14d\",\n \"mashupAddToWishlistViews14d\",\n \"mashupBackupImage\",\n \"mashupBackupImageClicks\",\n \"mashupBackupImageCPA\",\n \"mashupBackupImageCVR\",\n \"mashupBackupImageViews\",\n \"mashupClickToPage\",\n \"mashupClickToPageClicks\",\n \"mashupClickToPageCPA\",\n \"mashupClickToPageCVR\",\n \"mashupClickToPageViews\",\n \"mashupClipCouponClick14d\",\n \"mashupClipCouponClickClicks14d\",\n \"mashupClipCouponClickCPA14d\",\n \"mashupClipCouponClickCVR14d\",\n \"mashupClipCouponClickViews14d\",\n \"mashupShopNowClick14d\",\n \"mashupShopNowClickClicks14d\",\n \"mashupShopNowClickCPA14d\",\n \"mashupShopNowClickCVR14d\",\n \"mashupShopNowClickViews14d\",\n \"mashupSubscribeAndSave14d\",\n \"mashupSubscribeAndSaveClick14d\",\n \"mashupSubscribeAndSaveClickViews14d\",\n \"mashupSubscribeAndSaveCPA14d\",\n \"mashupSubscribeAndSaveCVR14d\",\n \"measurableImpressions\",\n \"measurableRate\",\n \"messageSent14d\",\n \"messageSentClicks14d\",\n \"messageSentCPA14d\",\n \"messageSentCVR14d\",\n \"messageSentViews14d\",\n \"mobileAppFirstStartClicks14d\",\n \"mobileAppFirstStartCVR14d\",\n \"mobileAppFirstStarts14d\",\n \"mobileAppFirstStartsCPA14d\",\n \"mobileAppFirstStartViews14d\",\n \"newSubscribeAndSave14d\",\n \"newSubscribeAndSaveClicks14d\",\n \"newSubscribeAndSaveRate14d\",\n \"newSubscribeAndSaveViews14d\",\n \"newToBrandECPP14d\",\n \"newToBrandERPM14d\",\n \"newToBrandProductSales14d\",\n \"newToBrandPurchaseRate14d\",\n \"newToBrandPurchases14d\",\n \"newToBrandPurchasesClicks14d\",\n \"newToBrandPurchasesViews14d\",\n \"newToBrandROAS14d\",\n \"newToBrandUnitsSold14d\",\n \"offAmazonClicks14d\",\n \"offAmazonConversions14d\",\n \"offAmazonCPA14d\",\n \"offAmazonCVR14d\",\n \"offAmazonECPP14d\",\n \"offAmazonERPM14d\",\n \"offAmazonProductSales14d\",\n \"offAmazonPurchaseRate14d\",\n \"offAmazonPurchases14d\",\n \"offAmazonPurchasesClicks14d\",\n \"offAmazonPurchasesViews14d\",\n \"offAmazonROAS14d\",\n \"offAmazonUnitsSold14d\",\n \"offAmazonViews14d\",\n \"percentOfPurchasesNewToBrand14d\",\n \"playerTrailersClicks14d\",\n \"playTrailerRate14d\",\n \"playTrailers14d\",\n \"playTrailersViews14d\",\n \"pRPV14d\",\n \"pRPVClicks14d\",\n \"pRPVr14d\",\n \"pRPVViews14d\",\n \"purchaseButton14d\",\n \"purchaseButtonClicks14d\",\n \"purchaseButtonCPA14d\",\n \"purchaseButtonCVR14d\",\n \"purchaseButtonViews14d\",\n \"purchaseRate14d\",\n \"purchases14d\",\n \"purchasesClicks14d\",\n \"purchasesViews14d\",\n \"referral14d\",\n \"referralClicks14d\",\n \"referralCPA14d\",\n \"referralCVR14d\",\n \"referralViews14d\",\n \"registrationConfirmPage14d\",\n \"registrationConfirmPageClicks14d\",\n \"registrationConfirmPageCPA14d\",\n \"registrationConfirmPageCVR14d\",\n \"registrationConfirmPageViews14d\",\n \"registrationForm14d\",\n \"registrationFormClicks14d\",\n \"registrationFormCPA14d\",\n \"registrationFormCVR14d\",\n \"registrationFormViews14d\",\n \"rentalRate14d\",\n \"rentals14d\",\n \"rentalsClicks14d\",\n \"rentalsViews14d\",\n \"ROAS14d\",\n \"sales14d\",\n \"signUp14d\",\n \"signUpClicks14d\",\n \"signUpCPA14d\",\n \"signUpCVR14d\",\n \"signUpPage14d\",\n \"signUpPageClicks14d\",\n \"signUpPageCPA14d\",\n \"signUpPageCVR14d\",\n \"signUpPageViews14d\",\n \"signUpViews14d\",\n \"storeLocatorPage14d\",\n \"storeLocatorPageClicks14d\",\n \"storeLocatorPageCPA14d\",\n \"storeLocatorPageCVR14d\",\n \"storeLocatorPageViews14d\",\n \"submitButton14d\",\n \"submitButtonClicks14d\",\n \"submitButtonCPA14d\",\n \"submitButtonCVR14d\",\n \"submitButtonViews14d\",\n \"subscribe14d\",\n \"subscribeClicks14d\",\n \"subscribeCPA14d\",\n \"subscribeCVR14d\",\n \"subscribeViews14d\",\n \"subscriptionButton14d\",\n \"subscriptionButtonClicks14d\",\n \"subscriptionButtonCPA14d\",\n \"subscriptionButtonCVR14d\",\n \"subscriptionButtonViews14d\",\n \"successPage14d\",\n \"successPageClicks14d\",\n \"successPageCPA14d\",\n \"successPageCVR14d\",\n \"successPageViews14d\",\n \"supplyCost\",\n \"surveyFinish14d\",\n \"surveyFinishClicks14d\",\n \"surveyFinishCPA14d\",\n \"surveyFinishCVR14d\",\n \"surveyFinishViews14d\",\n \"surveyStart14d\",\n \"surveyStartClicks14d\",\n \"surveyStartCPA14d\",\n \"surveyStartCVR14d\",\n \"surveyStartViews14d\",\n \"thankYouPage14d\",\n \"thankYouPageClicks14d\",\n \"thankYouPageCPA14d\",\n \"thankYouPageCVR14d\",\n \"thankYouPageViews14d\",\n \"totalAddToCart14d\",\n \"totalAddToCartClicks14d\",\n \"totalAddToCartCPA14d\",\n \"totalAddToCartCVR14d\",\n \"totalAddToCartViews14d\",\n \"totalAddToList14d\",\n \"totalAddToListClicks14d\",\n \"totalAddToListCPA14d\",\n \"totalAddToListCVR14d\",\n \"totalAddToListViews14d\",\n \"totalCost\",\n \"totalDetailPageClicks14d\",\n \"totalDetailPageViews14d\",\n \"totalDetailPageViewsCVR14d\",\n \"totalDetailPageViewViews14d\",\n \"totalDetaiPageViewCPA14d\",\n \"totalECPP14d\",\n \"totalECPPRPV14d\",\n \"totalERPM14d\",\n \"totalFee\",\n \"totalNewToBrandECPP14d\",\n \"totalNewToBrandERPM14d\",\n \"totalNewToBrandProductSales14d\",\n \"totalNewToBrandPurchaseRate14d\",\n \"totalNewToBrandPurchases14d\",\n \"totalNewToBrandPurchasesClicks14d\",\n \"totalNewToBrandPurchasesViews14d\",\n \"totalNewToBrandROAS14d\",\n \"totalNewToBrandUnitsSold14d\",\n \"totalPercentOfPurchasesNewToBrand14d\",\n \"totalPRPV14d\",\n \"totalPRPVClicks14d\",\n \"totalPRPVr14d\",\n \"totalPRPVViews14d\",\n \"totalPurchaseRate14d\",\n \"totalPurchases14d\",\n \"totalPurchasesClicks14d\",\n \"totalPurchasesViews14d\",\n \"totalROAS14d\",\n \"totalSales14d\",\n \"totalSubscribeAndSaveSubscriptionClicks14d\",\n \"totalSubscribeAndSaveSubscriptionCPA14d\",\n \"totalSubscribeAndSaveSubscriptionCVR14d\",\n \"totalSubscribeAndSaveSubscriptions14d\",\n \"totalSubscribeAndSaveSubscriptionViews14d\",\n \"totalUnitsSold14d\",\n \"unitsSold14d\",\n \"videoComplete\",\n \"videoCompleted\",\n \"videoCompletedCPA\",\n \"videoCompletedCVR\",\n \"videoCompletedViews\",\n \"videoCompletionRate\",\n \"videoDownloadRate14d\",\n \"videoDownloads14d\",\n \"videoDownloadsClicks14d\",\n \"videoDownloadsViews14d\",\n \"videoEndClicks\",\n \"videoFirstQuartile\",\n \"videoMidpoint\",\n \"videoMute\",\n \"videoPause\",\n \"videoResume\",\n \"videoStart\",\n \"videoStarted\",\n \"videoStartedClicks\",\n \"videoStartedCPA\",\n \"videoStartedCVR\",\n \"videoStartedViews\",\n \"videoStreams14d\",\n \"videoStreamsClicks14d\",\n \"videoStreamsRate14d\",\n \"videoStreamsViews14d\",\n \"videoThirdQuartile\",\n \"videoUnmute\",\n \"viewabilityRate\",\n \"viewableImpressions\",\n \"widgetInteraction14d\",\n \"widgetInteractionClicks14d\",\n \"widgetInteractionCPA14d\",\n \"widgetInteractionCVR14d\",\n \"widgetInteractionViews14d\",\n \"widgetLoad14d\",\n \"widgetLoadClicks14d\",\n \"widgetLoadCPA14d\",\n \"widgetLoadCVR14d\",\n \"widgetLoadViews14d\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 18:32:08 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "192" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "VWXKM8B9S3P287JDMVYK" }, { "key": "x-amzn-RequestId", "value": "daec928a-63d5-4c7c-b9e2-d8973f71afc5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "192" }, { "key": "x-amz-apigw-id", "value": "d3rCVFdooAMFheQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63ac8ba8-8e66dc53659956d7dec784f7" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 18:32:08 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"f8c38a51-0b59-f7c7-d100-9d3ddb8bc22e\",\n \"type\": \"CAMPAIGN\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2023-03-24T18:19:39.715Z\"\n}" }, { "name": "Inventory", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2022-12-21\",\n \"endDate\": \"2022-12-27\",\n \"type\": \"INVENTORY\",\n \"dimensions\": [\n \"SUPPLY\",\n \"DEAL\"\n ],\n \"metrics\": [\n \"accept14d\",\n \"acceptClicks14d\",\n \"acceptCPA14d\",\n \"acceptCVR14d\",\n \"acceptViews14d\",\n \"addedToShoppingCart14d\",\n \"addedToShoppingCartClicks14d\",\n \"addedToShoppingCartCPA14d\",\n \"addedToShoppingCartCVR14d\",\n \"addedToShoppingCartViews14d\",\n \"addToWatchlist14d\",\n \"addToWatchlistClicks14d\",\n \"addToWatchlistCPA14d\",\n \"addToWatchlistCVR14d\",\n \"addToWatchlistViews14d\",\n \"advertiserCountry\",\n \"advertiserTimezone\",\n \"amazonAudienceFee\",\n \"amazonPlatformFee\",\n \"application14d\",\n \"applicationClicks14d\",\n \"applicationCPA14d\",\n \"applicationCVR14d\",\n \"applicationViews14d\",\n \"atc14d\",\n \"atcClicks14d\",\n \"atcr14d\",\n \"atcViews14d\",\n \"atl14d\",\n \"atlClicks14d\",\n \"atlr14d\",\n \"atlViews14d\",\n \"bannerInteraction14d\",\n \"bannerInteractionClicks14d\",\n \"bannerInteractionCPA14d\",\n \"bannerInteractionCVR14d\",\n \"bannerInteractionViews14d\",\n \"brandSearch14d\",\n \"brandSearchClicks14d\",\n \"brandSearchCPA14d\",\n \"brandSearchRate14d\",\n \"brandSearchViews14d\",\n \"brandStoreEngagement1\",\n \"brandStoreEngagement1Clicks\",\n \"brandStoreEngagement1CPA\",\n \"brandStoreEngagement1CVR\",\n \"brandStoreEngagement1Views\",\n \"brandStoreEngagement2\",\n \"brandStoreEngagement2Clicks\",\n \"brandStoreEngagement2CPA\",\n \"brandStoreEngagement2CVR\",\n \"brandStoreEngagement2Views\",\n \"brandStoreEngagement3\",\n \"brandStoreEngagement3Clicks\",\n \"brandStoreEngagement3CPA\",\n \"brandStoreEngagement3CVR\",\n \"brandStoreEngagement3Views\",\n \"brandStoreEngagement4\",\n \"brandStoreEngagement4Clicks\",\n \"brandStoreEngagement4CPA\",\n \"brandStoreEngagement4CVR\",\n \"brandStoreEngagement4Views\",\n \"brandStoreEngagement5\",\n \"brandStoreEngagement5Clicks\",\n \"brandStoreEngagement5CPA\",\n \"brandStoreEngagement5CVR\",\n \"brandStoreEngagement5Views\",\n \"brandStoreEngagement6\",\n \"brandStoreEngagement6Clicks\",\n \"brandStoreEngagement6CPA\",\n \"brandStoreEngagement6CVR\",\n \"brandStoreEngagement6Views\",\n \"brandStoreEngagement7\",\n \"brandStoreEngagement7Clicks\",\n \"brandStoreEngagement7CPA\",\n \"brandStoreEngagement7CVR\",\n \"brandStoreEngagement7Views\",\n \"clickOnRedirect14d\",\n \"clickOnRedirectClicks14d\",\n \"clickOnRedirectCPA14d\",\n \"clickOnRedirectCVR14d\",\n \"clickOnRedirectViews14d\",\n \"clickThroughs\",\n \"CTR\",\n \"decline14d\",\n \"declineClicks14d\",\n \"declineCPA14d\",\n \"declineCVR14d\",\n \"declineViews14d\",\n \"downloadedVideoPlayRate14d\",\n \"downloadedVideoPlays14d\",\n \"downloadedVideoPlaysClicks14d\",\n \"downloadedVideoPlaysViews14d\",\n \"dpv14d\",\n \"dpvClicks14d\",\n \"dpvr14d\",\n \"dpvViews14d\",\n \"dropDownSelection14d\",\n \"dropDownSelectionClicks14d\",\n \"dropDownSelectionCPA14d\",\n \"dropDownSelectionCVR14d\",\n \"dropDownSelectionViews14d\",\n \"eCPAtc14d\",\n \"eCPAtl14d\",\n \"eCPC\",\n \"eCPDPV14d\",\n \"eCPDVP14d\",\n \"eCPM\",\n \"eCPnewSubscribeAndSave14d\",\n \"eCPP14d\",\n \"eCPPRPV14d\",\n \"eCPPT14d\",\n \"ecpr14d\",\n \"ecpvc\",\n \"ecpvd14d\",\n \"eCPVS14d\",\n \"emailInteraction14d\",\n \"emailInteractionClicks14d\",\n \"emailInteractionCPA14d\",\n \"emailInteractionCVR14d\",\n \"emailInteractionViews14d\",\n \"emailLoad14d\",\n \"emailLoadClicks14d\",\n \"emailLoadCPA14d\",\n \"emailLoadCVR14d\",\n \"emailLoadViews14d\",\n \"gameInteraction14d\",\n \"gameInteractionClicks14d\",\n \"gameInteractionCPA14d\",\n \"gameInteractionCVR14d\",\n \"gameInteractionViews14d\",\n \"gameLoad14d\",\n \"gameLoadClicks14d\",\n \"gameLoadCPA14d\",\n \"gameLoadCVR14d\",\n \"gameLoadViews14d\",\n \"grossClickThroughs\",\n \"grossImpressions\",\n \"homepageVisit14d\",\n \"homepageVisitClicks14d\",\n \"homepageVisitCPA14d\",\n \"homepageVisitCVR14d\",\n \"homepageVisitViews14d\",\n \"impressions\",\n \"invalidClickThroughs\",\n \"invalidClickThroughsRate\",\n \"invalidImpressionRate\",\n \"invalidImpressions\",\n \"marketingLandingPage14d\",\n \"marketingLandingPageClicks14d\",\n \"marketingLandingPageCPA14d\",\n \"marketingLandingPageCVR14d\",\n \"marketingLandingPageViews14d\",\n \"mashupAddToCart14d\",\n \"mashupAddToCartClickCVR14d\",\n \"mashupAddToCartClicks14d\",\n \"mashupAddToCartCPA14d\",\n \"mashupAddToCartViews14d\",\n \"mashupAddToWishlist14d\",\n \"mashupAddToWishlistClicks14d\",\n \"mashupAddToWishlistCPA14d\",\n \"mashupAddToWishlistCVR14d\",\n \"mashupAddToWishlistViews14d\",\n \"mashupBackupImage\",\n \"mashupBackupImageClicks\",\n \"mashupBackupImageCPA\",\n \"mashupBackupImageCVR\",\n \"mashupBackupImageViews\",\n \"mashupClickToPage\",\n \"mashupClickToPageClicks\",\n \"mashupClickToPageCPA\",\n \"mashupClickToPageCVR\",\n \"mashupClickToPageViews\",\n \"mashupClipCouponClick14d\",\n \"mashupClipCouponClickClicks14d\",\n \"mashupClipCouponClickCPA14d\",\n \"mashupClipCouponClickCVR14d\",\n \"mashupClipCouponClickViews14d\",\n \"mashupShopNowClick14d\",\n \"mashupShopNowClickClicks14d\",\n \"mashupShopNowClickCPA14d\",\n \"mashupShopNowClickCVR14d\",\n \"mashupShopNowClickViews14d\",\n \"mashupSubscribeAndSave14d\",\n \"mashupSubscribeAndSaveClick14d\",\n \"mashupSubscribeAndSaveClickViews14d\",\n \"mashupSubscribeAndSaveCPA14d\",\n \"mashupSubscribeAndSaveCVR14d\",\n \"messageSent14d\",\n \"messageSentClicks14d\",\n \"messageSentCPA14d\",\n \"messageSentCVR14d\",\n \"messageSentViews14d\",\n \"mobileAppFirstStartClicks14d\",\n \"mobileAppFirstStartCVR14d\",\n \"mobileAppFirstStarts14d\",\n \"mobileAppFirstStartsCPA14d\",\n \"mobileAppFirstStartViews14d\",\n \"newSubscribeAndSave14d\",\n \"newSubscribeAndSaveClicks14d\",\n \"newSubscribeAndSaveRate14d\",\n \"newSubscribeAndSaveViews14d\",\n \"newToBrandECPP14d\",\n \"newToBrandPurchaseRate14d\",\n \"newToBrandPurchases14d\",\n \"newToBrandPurchasesClicks14d\",\n \"newToBrandPurchasesViews14d\",\n \"offAmazonClicks14d\",\n \"offAmazonConversions14d\",\n \"offAmazonCPA14d\",\n \"offAmazonCVR14d\",\n \"offAmazonECPP14d\",\n \"offAmazonPurchaseRate14d\",\n \"offAmazonPurchases14d\",\n \"offAmazonPurchasesClicks14d\",\n \"offAmazonPurchasesViews14d\",\n \"offAmazonViews14d \",\n \"percentOfPurchasesNewToBrand14d\",\n \"playerTrailersClicks14d\",\n \"playTrailerRate14d\",\n \"playTrailers14d\",\n \"playTrailersViews14d\",\n \"pRPV14d\",\n \"pRPVClicks14d\",\n \"pRPVr14d\",\n \"pRPVViews14d\",\n \"purchaseButton14d\",\n \"purchaseButtonClicks14d\",\n \"purchaseButtonCPA14d\",\n \"purchaseButtonCVR14d\",\n \"purchaseButtonViews14d\",\n \"purchaseRate14d\",\n \"purchases14d\",\n \"purchasesClicks14d\",\n \"purchasesViews14d\",\n \"referral14d\",\n \"referralClicks14d\",\n \"referralCPA14d\",\n \"referralCVR14d\",\n \"referralViews14d\",\n \"registrationConfirmPage14d\",\n \"registrationConfirmPageClicks14d\",\n \"registrationConfirmPageCPA14d\",\n \"registrationConfirmPageCVR14d\",\n \"registrationConfirmPageViews14d\",\n \"registrationForm14d\",\n \"registrationFormClicks14d\",\n \"registrationFormCPA14d\",\n \"registrationFormCVR14d\",\n \"registrationFormViews14d\",\n \"rentalRate14d\",\n \"rentals14d\",\n \"rentalsClicks14d\",\n \"rentalsViews14d\",\n \"signUp14d\",\n \"signUpClicks14d\",\n \"signUpCPA14d\",\n \"signUpCVR14d\",\n \"signUpPage14d\",\n \"signUpPageClicks14d\",\n \"signUpPageCPA14d\",\n \"signUpPageCVR14d\",\n \"signUpPageViews14d\",\n \"signUpViews14d\",\n \"storeLocatorPage14d\",\n \"storeLocatorPageClicks14d\",\n \"storeLocatorPageCPA14d\",\n \"storeLocatorPageCVR14d\",\n \"storeLocatorPageViews14d\",\n \"submitButton14d\",\n \"submitButtonClicks14d\",\n \"submitButtonCPA14d\",\n \"submitButtonCVR14d\",\n \"submitButtonViews14d\",\n \"subscribe14d\",\n \"subscribeClicks14d\",\n \"subscribeCPA14d\",\n \"subscribeCVR14d\",\n \"subscribeViews14d\",\n \"subscriptionButton14d\",\n \"subscriptionButtonClicks14d\",\n \"subscriptionButtonCPA14d\",\n \"subscriptionButtonCVR14d\",\n \"subscriptionButtonViews14d\",\n \"successPage14d\",\n \"successPageClicks14d\",\n \"successPageCPA14d\",\n \"successPageCVR14d\",\n \"successPageViews14d\",\n \"supplyCost\",\n \"surveyFinish14d\",\n \"surveyFinishClicks14d\",\n \"surveyFinishCPA14d\",\n \"surveyFinishCVR14d\",\n \"surveyFinishViews14d\",\n \"surveyStart14d\",\n \"surveyStartClicks14d\",\n \"surveyStartCPA14d\",\n \"surveyStartCVR14d\",\n \"surveyStartViews14d\",\n \"thankYouPage14d\",\n \"thankYouPageClicks14d\",\n \"thankYouPageCPA14d\",\n \"thankYouPageCVR14d\",\n \"thankYouPageViews14d\",\n \"totalCost\",\n \"videoComplete\",\n \"videoCompleted\",\n \"videoCompletedCPA\",\n \"videoCompletedCVR\",\n \"videoCompletedViews\",\n \"videoCompletionRate\",\n \"videoDownloadRate14d\",\n \"videoDownloads14d\",\n \"videoDownloadsClicks14d\",\n \"videoDownloadsViews14d\",\n \"videoEndClicks\",\n \"videoFirstQuartile\",\n \"videoMidpoint\",\n \"videoMute\",\n \"videoPause\",\n \"videoResume\",\n \"videoStart\",\n \"videoStarted\",\n \"videoStartedClicks\",\n \"videoStartedCPA\",\n \"videoStartedCVR\",\n \"videoStartedViews\",\n \"videoStreams14d\",\n \"videoStreamsClicks14d\",\n \"videoStreamsRate14d\",\n \"videoStreamsViews14d\",\n \"videoThirdQuartile\",\n \"videoUnmute\",\n \"widgetInteraction14d\",\n \"widgetInteractionClicks14d\",\n \"widgetInteractionCPA14d\",\n \"widgetInteractionCVR14d\",\n \"widgetInteractionViews14d\",\n \"widgetLoad14d\",\n \"widgetLoadClicks14d\",\n \"widgetLoadCPA14d\",\n \"widgetLoadCVR14d\",\n \"widgetLoadViews14d\",\n \"agencyFee\",\n \"totalFee\",\n \"3pFeeAutomotive\",\n \"3pFeeAutomotiveAbsorbed\",\n \"3pFeeComScore\",\n \"3pFeeComScoreAbsorbed\",\n \"3pFeeCPM1\",\n \"3pFeeCPM1Absorbed\",\n \"3pFeeCPM2\",\n \"3pFeeCPM2Absorbed\",\n \"3pFeeCPM3\",\n \"3pFeeCPM3Absorbed\",\n \"3pFeeDoubleclickCampaignManager\",\n \"3pFeeDoubleclickCampaignManagerAbsorbed\",\n \"3pFeeDoubleVerify\",\n \"3pFeeDoubleVerifyAbsorbed\",\n \"3pFeeIntegralAdScience\",\n \"3pFeeIntegralAdScienceAbsorbed\",\n \"3PFees\",\n \"unitsSold14d\",\n \"sales14d\",\n \"ROAS14d\",\n \"eRPM14d\",\n \"newToBrandUnitsSold14d\",\n \"newToBrandProductSales14d\",\n \"newToBrandROAS14d\",\n \"newToBrandERPM14d\",\n \"totalPRPV14d\",\n \"totalPRPVViews14d\",\n \"totalPRPVClicks14d\",\n \"totalPRPVr14d\",\n \"totalECPPRPV14d\",\n \"totalPurchases14d\",\n \"totalPurchasesViews14d\",\n \"totalPurchasesClicks14d\",\n \"totalPurchaseRate14d\",\n \"totalECPP14d\",\n \"totalNewToBrandPurchases14d\",\n \"totalNewToBrandPurchasesViews14d\",\n \"totalNewToBrandPurchasesClicks14d\",\n \"totalNewToBrandPurchaseRate14d\",\n \"totalNewToBrandECPP14d\",\n \"totalPercentOfPurchasesNewToBrand14d\",\n \"totalUnitsSold14d\",\n \"totalSales14d\",\n \"totalROAS14d\",\n \"totalERPM14d\",\n \"totalNewToBrandUnitsSold14d\",\n \"totalNewToBrandProductSales14d\",\n \"totalNewToBrandROAS14d\",\n \"totalNewToBrandERPM14d\",\n \"viewableImpressions\",\n \"measurableImpressions\",\n \"measurableRate\",\n \"viewabilityRate\",\n \"totalDetailPageViews14d\",\n \"totalDetailPageViewViews14d\",\n \"totalDetailPageClicks14d\",\n \"totalDetailPageViewsCVR14d\",\n \"totalDetaiPageViewCPA14d\",\n \"totalAddToList14d\",\n \"totalAddToListViews14d\",\n \"totalAddToListClicks14d\",\n \"totalAddToListCVR14d\",\n \"totalAddToListCPA14d\",\n \"totalAddToCart14d\",\n \"totalAddToCartViews14d\",\n \"totalAddToCartClicks14d\",\n \"totalAddToCartCVR14d\",\n \"totalAddToCartCPA14d\",\n \"totalSubscribeAndSaveSubscriptions14d\",\n \"totalSubscribeAndSaveSubscriptionViews14d\",\n \"totalSubscribeAndSaveSubscriptionClicks14d\",\n \"totalSubscribeAndSaveSubscriptionCVR14d\",\n \"totalSubscribeAndSaveSubscriptionCPA14d\",\n \"offAmazonProductSales14d\",\n \"offAmazonUnitsSold14d\",\n \"offAmazonROAS14d\",\n \"offAmazonERPM14d\",\n \"combinedPurchases\",\n \"combinedPurchasesViews\",\n \"combinedPurchasesClicks\",\n \"combinedPurchaseRate\",\n \"combinedECPP\",\n \"combinedProductSales\",\n \"combinedUnitsSold\",\n \"combinedROAS\",\n \"combinedERPM\",\n \"dealType\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 18:42:02 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "193" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "AWYMH56KQFC61Y3889JK" }, { "key": "x-amzn-RequestId", "value": "f6e69bc8-4b83-4990-b703-65a7ccca0fec" }, { "key": "x-amzn-Remapped-Content-Length", "value": "193" }, { "key": "x-amz-apigw-id", "value": "d3sfAHmAIAMFhuw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63ac8dfa-087d60d2e24b4702bdf9fe6c" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 18:42:02 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"88c2ad05-4c5f-b0f6-029a-727c3913eccc\",\n \"type\": \"INVENTORY\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-12-28T19:42:02.063Z\"\n}" }, { "name": "Audience", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2022-12-21\",\n \"endDate\": \"2022-12-27\",\n \"type\": \"AUDIENCE\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\"\n ],\n \"metrics\": [\n \"accept14d\",\n \"acceptClicks14d\",\n \"acceptCPA14d\",\n \"acceptCVR14d\",\n \"acceptViews14d\",\n \"addedToShoppingCart14d\",\n \"addedToShoppingCartClicks14d\",\n \"addedToShoppingCartCPA14d\",\n \"addedToShoppingCartCVR14d\",\n \"addedToShoppingCartViews14d\",\n \"addToWatchlist14d\",\n \"addToWatchlistClicks14d\",\n \"addToWatchlistCPA14d\",\n \"addToWatchlistCVR14d\",\n \"addToWatchlistViews14d\",\n \"advertiserCountry\",\n \"advertiserTimezone\",\n \"amazonAudienceFee\",\n \"amazonPlatformFee\",\n \"application14d\",\n \"applicationClicks14d\",\n \"applicationCPA14d\",\n \"applicationCVR14d\",\n \"applicationViews14d\",\n \"atc14d\",\n \"atcClicks14d\",\n \"atcr14d\",\n \"atcViews14d\",\n \"atl14d\",\n \"atlClicks14d\",\n \"atlr14d\",\n \"atlViews14d\",\n \"bannerInteraction14d\",\n \"bannerInteractionClicks14d\",\n \"bannerInteractionCPA14d\",\n \"bannerInteractionCVR14d\",\n \"bannerInteractionViews14d\",\n \"brandSearch14d\",\n \"brandSearchClicks14d\",\n \"brandSearchCPA14d\",\n \"brandSearchRate14d\",\n \"brandSearchViews14d\",\n \"brandStoreEngagement1\",\n \"brandStoreEngagement1Clicks\",\n \"brandStoreEngagement1CPA\",\n \"brandStoreEngagement1CVR\",\n \"brandStoreEngagement1Views\",\n \"brandStoreEngagement2\",\n \"brandStoreEngagement2Clicks\",\n \"brandStoreEngagement2CPA\",\n \"brandStoreEngagement2CVR\",\n \"brandStoreEngagement2Views\",\n \"brandStoreEngagement3\",\n \"brandStoreEngagement3Clicks\",\n \"brandStoreEngagement3CPA\",\n \"brandStoreEngagement3CVR\",\n \"brandStoreEngagement3Views\",\n \"brandStoreEngagement4\",\n \"brandStoreEngagement4Clicks\",\n \"brandStoreEngagement4CPA\",\n \"brandStoreEngagement4CVR\",\n \"brandStoreEngagement4Views\",\n \"brandStoreEngagement5\",\n \"brandStoreEngagement5Clicks\",\n \"brandStoreEngagement5CPA\",\n \"brandStoreEngagement5CVR\",\n \"brandStoreEngagement5Views\",\n \"brandStoreEngagement6\",\n \"brandStoreEngagement6Clicks\",\n \"brandStoreEngagement6CPA\",\n \"brandStoreEngagement6CVR\",\n \"brandStoreEngagement6Views\",\n \"brandStoreEngagement7\",\n \"brandStoreEngagement7Clicks\",\n \"brandStoreEngagement7CPA\",\n \"brandStoreEngagement7CVR\",\n \"brandStoreEngagement7Views\",\n \"clickOnRedirect14d\",\n \"clickOnRedirectClicks14d\",\n \"clickOnRedirectCPA14d\",\n \"clickOnRedirectCVR14d\",\n \"clickOnRedirectViews14d\",\n \"clickThroughs\",\n \"CTR\",\n \"decline14d\",\n \"declineClicks14d\",\n \"declineCPA14d\",\n \"declineCVR14d\",\n \"declineViews14d\",\n \"downloadedVideoPlayRate14d\",\n \"downloadedVideoPlays14d\",\n \"downloadedVideoPlaysClicks14d\",\n \"downloadedVideoPlaysViews14d\",\n \"dpv14d\",\n \"dpvClicks14d\",\n \"dpvr14d\",\n \"dpvViews14d\",\n \"dropDownSelection14d\",\n \"dropDownSelectionClicks14d\",\n \"dropDownSelectionCPA14d\",\n \"dropDownSelectionCVR14d\",\n \"dropDownSelectionViews14d\",\n \"eCPAtc14d\",\n \"eCPAtl14d\",\n \"eCPC\",\n \"eCPDPV14d\",\n \"eCPDVP14d\",\n \"eCPM\",\n \"eCPnewSubscribeAndSave14d\",\n \"eCPP14d\",\n \"eCPPRPV14d\",\n \"eCPPT14d\",\n \"ecpr14d\",\n \"ecpvc\",\n \"ecpvd14d\",\n \"eCPVS14d\",\n \"emailInteraction14d\",\n \"emailInteractionClicks14d\",\n \"emailInteractionCPA14d\",\n \"emailInteractionCVR14d\",\n \"emailInteractionViews14d\",\n \"emailLoad14d\",\n \"emailLoadClicks14d\",\n \"emailLoadCPA14d\",\n \"emailLoadCVR14d\",\n \"emailLoadViews14d\",\n \"gameInteraction14d\",\n \"gameInteractionClicks14d\",\n \"gameInteractionCPA14d\",\n \"gameInteractionCVR14d\",\n \"gameInteractionViews14d\",\n \"gameLoad14d\",\n \"gameLoadClicks14d\",\n \"gameLoadCPA14d\",\n \"gameLoadCVR14d\",\n \"gameLoadViews14d\",\n \"grossClickThroughs\",\n \"grossImpressions\",\n \"homepageVisit14d\",\n \"homepageVisitClicks14d\",\n \"homepageVisitCPA14d\",\n \"homepageVisitCVR14d\",\n \"homepageVisitViews14d\",\n \"impressions\",\n \"invalidClickThroughs\",\n \"invalidClickThroughsRate\",\n \"invalidImpressionRate\",\n \"invalidImpressions\",\n \"marketingLandingPage14d\",\n \"marketingLandingPageClicks14d\",\n \"marketingLandingPageCPA14d\",\n \"marketingLandingPageCVR14d\",\n \"marketingLandingPageViews14d\",\n \"mashupAddToCart14d\",\n \"mashupAddToCartClickCVR14d\",\n \"mashupAddToCartClicks14d\",\n \"mashupAddToCartCPA14d\",\n \"mashupAddToCartViews14d\",\n \"mashupAddToWishlist14d\",\n \"mashupAddToWishlistClicks14d\",\n \"mashupAddToWishlistCPA14d\",\n \"mashupAddToWishlistCVR14d\",\n \"mashupAddToWishlistViews14d\",\n \"mashupBackupImage\",\n \"mashupBackupImageClicks\",\n \"mashupBackupImageCPA\",\n \"mashupBackupImageCVR\",\n \"mashupBackupImageViews\",\n \"mashupClickToPage\",\n \"mashupClickToPageClicks\",\n \"mashupClickToPageCPA\",\n \"mashupClickToPageCVR\",\n \"mashupClickToPageViews\",\n \"mashupClipCouponClick14d\",\n \"mashupClipCouponClickClicks14d\",\n \"mashupClipCouponClickCPA14d\",\n \"mashupClipCouponClickCVR14d\",\n \"mashupClipCouponClickViews14d\",\n \"mashupShopNowClick14d\",\n \"mashupShopNowClickClicks14d\",\n \"mashupShopNowClickCPA14d\",\n \"mashupShopNowClickCVR14d\",\n \"mashupShopNowClickViews14d\",\n \"mashupSubscribeAndSave14d\",\n \"mashupSubscribeAndSaveClick14d\",\n \"mashupSubscribeAndSaveClickViews14d\",\n \"mashupSubscribeAndSaveCPA14d\",\n \"mashupSubscribeAndSaveCVR14d\",\n \"messageSent14d\",\n \"messageSentClicks14d\",\n \"messageSentCPA14d\",\n \"messageSentCVR14d\",\n \"messageSentViews14d\",\n \"mobileAppFirstStartClicks14d\",\n \"mobileAppFirstStartCVR14d\",\n \"mobileAppFirstStarts14d\",\n \"mobileAppFirstStartsCPA14d\",\n \"mobileAppFirstStartViews14d\",\n \"newSubscribeAndSave14d\",\n \"newSubscribeAndSaveClicks14d\",\n \"newSubscribeAndSaveRate14d\",\n \"newSubscribeAndSaveViews14d\",\n \"newToBrandECPP14d\",\n \"newToBrandPurchaseRate14d\",\n \"newToBrandPurchases14d\",\n \"newToBrandPurchasesClicks14d\",\n \"newToBrandPurchasesViews14d\",\n \"offAmazonClicks14d\",\n \"offAmazonConversions14d\",\n \"offAmazonCPA14d\",\n \"offAmazonCVR14d\",\n \"offAmazonECPP14d\",\n \"offAmazonPurchaseRate14d\",\n \"offAmazonPurchases14d\",\n \"offAmazonPurchasesClicks14d\",\n \"offAmazonPurchasesViews14d\",\n \"offAmazonViews14d\",\n \"percentOfPurchasesNewToBrand14d\",\n \"playerTrailersClicks14d\",\n \"playTrailerRate14d\",\n \"playTrailers14d\",\n \"playTrailersViews14d\",\n \"pRPV14d\",\n \"pRPVClicks14d\",\n \"pRPVr14d\",\n \"pRPVViews14d\",\n \"purchaseButton14d\",\n \"purchaseButtonClicks14d\",\n \"purchaseButtonCPA14d\",\n \"purchaseButtonCVR14d\",\n \"purchaseButtonViews14d\",\n \"purchaseRate14d\",\n \"purchases14d\",\n \"purchasesClicks14d\",\n \"purchasesViews14d\",\n \"referral14d\",\n \"referralClicks14d\",\n \"referralCPA14d\",\n \"referralCVR14d\",\n \"referralViews14d\",\n \"registrationConfirmPage14d\",\n \"registrationConfirmPageClicks14d\",\n \"registrationConfirmPageCPA14d\",\n \"registrationConfirmPageCVR14d\",\n \"registrationConfirmPageViews14d\",\n \"registrationForm14d\",\n \"registrationFormClicks14d\",\n \"registrationFormCPA14d\",\n \"registrationFormCVR14d\",\n \"registrationFormViews14d\",\n \"rentalRate14d\",\n \"rentals14d\",\n \"rentalsClicks14d\",\n \"rentalsViews14d\",\n \"signUp14d\",\n \"signUpClicks14d\",\n \"signUpCPA14d\",\n \"signUpCVR14d\",\n \"signUpPage14d\",\n \"signUpPageClicks14d\",\n \"signUpPageCPA14d\",\n \"signUpPageCVR14d\",\n \"signUpPageViews14d\",\n \"signUpViews14d\",\n \"storeLocatorPage14d\",\n \"storeLocatorPageClicks14d\",\n \"storeLocatorPageCPA14d\",\n \"storeLocatorPageCVR14d\",\n \"storeLocatorPageViews14d\",\n \"submitButton14d\",\n \"submitButtonClicks14d\",\n \"submitButtonCPA14d\",\n \"submitButtonCVR14d\",\n \"submitButtonViews14d\",\n \"subscribe14d\",\n \"subscribeClicks14d\",\n \"subscribeCPA14d\",\n \"subscribeCVR14d\",\n \"subscribeViews14d\",\n \"subscriptionButton14d\",\n \"subscriptionButtonClicks14d\",\n \"subscriptionButtonCPA14d\",\n \"subscriptionButtonCVR14d\",\n \"subscriptionButtonViews14d\",\n \"successPage14d\",\n \"successPageClicks14d\",\n \"successPageCPA14d\",\n \"successPageCVR14d\",\n \"successPageViews14d\",\n \"supplyCost\",\n \"surveyFinish14d\",\n \"surveyFinishClicks14d\",\n \"surveyFinishCPA14d\",\n \"surveyFinishCVR14d\",\n \"surveyFinishViews14d\",\n \"surveyStart14d\",\n \"surveyStartClicks14d\",\n \"surveyStartCPA14d\",\n \"surveyStartCVR14d\",\n \"surveyStartViews14d\",\n \"thankYouPage14d\",\n \"thankYouPageClicks14d\",\n \"thankYouPageCPA14d\",\n \"thankYouPageCVR14d\",\n \"thankYouPageViews14d\",\n \"totalCost\",\n \"videoComplete\",\n \"videoCompleted\",\n \"videoCompletedCPA\",\n \"videoCompletedCVR\",\n \"videoCompletedViews\",\n \"videoCompletionRate\",\n \"videoDownloadRate14d\",\n \"videoDownloads14d\",\n \"videoDownloadsClicks14d\",\n \"videoDownloadsViews14d\",\n \"videoEndClicks\",\n \"videoFirstQuartile\",\n \"videoMidpoint\",\n \"videoMute\",\n \"videoPause\",\n \"videoResume\",\n \"videoStart\",\n \"videoStarted\",\n \"videoStartedClicks\",\n \"videoStartedCPA\",\n \"videoStartedCVR\",\n \"videoStartedViews\",\n \"videoStreams14d\",\n \"videoStreamsClicks14d\",\n \"videoStreamsRate14d\",\n \"videoStreamsViews14d\",\n \"videoThirdQuartile\",\n \"videoUnmute\",\n \"widgetInteraction14d\",\n \"widgetInteractionClicks14d\",\n \"widgetInteractionCPA14d\",\n \"widgetInteractionCVR14d\",\n \"widgetInteractionViews14d\",\n \"widgetLoad14d\",\n \"widgetLoadClicks14d\",\n \"widgetLoadCPA14d\",\n \"widgetLoadCVR14d\",\n \"widgetLoadViews14d\",\n \"lineitemtype\",\n \"segmentClassCode\",\n \"segmentSource\",\n \"segmentType\",\n \"segmentMarketplaceID\",\n \"targetingMethod\",\n \"combinedPurchases\",\n \"combinedPurchasesViews\",\n \"combinedPurchasesClicks\",\n \"combinedPurchaseRate\",\n \"combinedECPP\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 18:45:40 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "192" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "BNRY8S0920AX300RYW9G" }, { "key": "x-amzn-RequestId", "value": "52026f5e-a17e-47a8-ab6c-ff81c104c2d0" }, { "key": "x-amzn-Remapped-Content-Length", "value": "192" }, { "key": "x-amz-apigw-id", "value": "d3tBLFijoAMFQOw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63ac8ed4-b5807fa6f59f2ec8e8801165" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 18:45:39 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"c8c2ad06-f728-0140-9e07-e4b2982c40ed\",\n \"type\": \"AUDIENCE\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-12-28T19:45:40.581Z\"\n}" }, { "name": "Products", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2022-12-21\",\n \"endDate\": \"2022-12-27\",\n \"type\": \"PRODUCTS\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\"\n ],\n \"metrics\": [\n \"productName\",\n \"productGroup\",\n \"productCategory\",\n \"productSubcategory\",\n \"dpv14d\",\n \"dpvViews14d\",\n \"dpvClicks14d\",\n \"pRPV14d\",\n \"pRPVViews14d\",\n \"pRPVClicks14d\",\n \"atl14d\",\n \"atlViews14d\",\n \"atlClicks14d\",\n \"atc14d\",\n \"atcViews14d\",\n \"atcClicks14d\",\n \"purchases14d\",\n \"purchasesViews14d\",\n \"purchasesClicks14d\",\n \"newToBrandPurchases14d\",\n \"newToBrandPurchasesViews14d\",\n \"newToBrandPurchasesClicks14d\",\n \"percentOfPurchasesNewToBrand14d\",\n \"totalDetailPageViews14d\",\n \"totalDetailPageViewViews14d\",\n \"totalDetailPageClicks14d\",\n \"totalPRPV14d\",\n \"totalPRPVViews14d\",\n \"totalPRPVClicks14d\",\n \"totalAddToList14d\",\n \"totalAddToListViews14d\",\n \"totalAddToListClicks14d\",\n \"totalAddToCart14d\",\n \"totalAddToCartViews14d\",\n \"totalAddToCartClicks14d\",\n \"totalPurchases14d\",\n \"totalPurchasesViews14d\",\n \"totalPurchasesClicks14d\",\n \"totalNewToBrandPurchases14d\",\n \"totalNewToBrandPurchasesViews14d\",\n \"totalNewToBrandPurchasesClicks14d\",\n \"totalPercentOfPurchasesNewToBrand14d\",\n \"newSubscribeAndSave14d\",\n \"newSubscribeAndSaveViews14d\",\n \"newSubscribeAndSaveClicks14d\",\n \"totalSubscribeAndSaveSubscriptions14d\",\n \"totalSubscribeAndSaveSubscriptionViews14d\",\n \"totalSubscribeAndSaveSubscriptionClicks14d\",\n \"unitsSold14d\",\n \"sales14d\",\n \"totalUnitsSold14d\",\n \"totalSales14d\",\n \"newToBrandUnitsSold14d\",\n \"newToBrandProductSales14d\",\n \"brandHaloDetailPage14d\",\n \"brandHaloDetailPageViews14d\",\n \"brandHaloDetailPageClicks14d\",\n \"brandHaloProductReviewPage14d\",\n \"brandHaloProductReviewPageViews14d\",\n \"brandHaloProductReviewPageClicks14d\",\n \"brandHaloAddToList14d\",\n \"brandHaloAddToListViews14d\",\n \"brandHaloAddToListClicks14d\",\n \"brandHaloAddToCart14d\",\n \"brandHaloAddToCartViews14d\",\n \"brandHaloAddToCartClicks14d\",\n \"brandHaloPurchases14d\",\n \"brandHaloPurchasesViews14d\",\n \"brandHaloPurchasesClicks14d\",\n \"brandHaloNewToBrandPurchases14d\",\n \"brandHaloNewToBrandPurchasesViews14d\",\n \"brandHaloNewToBrandPurchasesClicks14d\",\n \"brandHaloPercentOfPurchasesNewToBrand14d\",\n \"brandHaloNewSubscribeAndSave14d\",\n \"combinedPurchases\",\n \"brandHaloNewSubscribeAndSaveViews14d\",\n \"brandHaloNewSubscribeAndSaveClicks14d\",\n \"brandHaloTotalUnitsSold14d\",\n \"brandHaloTotalSales14d\",\n \"brandHaloTotalNewToBrandSales14d\",\n \"brandHaloTotalNewToBrandUnitsSold14d\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 20:16:58 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "192" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1HYXSH36A5TEQ5JBC4J2" }, { "key": "x-amzn-RequestId", "value": "8870ef0b-5f65-4d42-8563-597448272883" }, { "key": "x-amzn-Remapped-Content-Length", "value": "192" }, { "key": "x-amz-apigw-id", "value": "d36ZHHovIAMFbRA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63aca43a-56bb3a72247f7b9f232c675b" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 20:16:58 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"7ec2ad30-c23a-1bdd-d97e-0c2072e24184\",\n \"type\": \"PRODUCTS\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-12-28T21:16:58.497Z\"\n}" }, { "name": "Technology", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2022-12-21\",\n \"endDate\": \"2022-12-27\",\n \"type\": \"TECHNOLOGY\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\",\n \"OPERATING_SYSTEM\",\n \"BROWSER_TYPE\",\n \"BROWSER_VERSION\",\n \"DEVICE_TYPE\",\n \"ENVIRONMENT_TYPE\"\n ],\n \"metrics\": [\n \"mashupShopNowClick14d\",\n \"mashupShopNowClickViews14d\",\n \"mashupShopNowClickClicks14d\",\n \"referral14d\",\n \"referralViews14d\",\n \"referralClicks14d\",\n \"accept14d\",\n \"acceptViews14d\",\n \"acceptClicks14d\",\n \"decline14d\",\n \"declineViews14d\",\n \"declineClicks14d\",\n \"dpv14d\",\n \"dpvViews14d\",\n \"dpvClicks14d\",\n \"pRPV14d\",\n \"pRPVViews14d\",\n \"pRPVClicks14d\",\n \"atl14d\",\n \"atlViews14d\",\n \"atlClicks14d\",\n \"atc14d\",\n \"atcViews14d\",\n \"atcClicks14d\",\n \"purchases14d\",\n \"purchasesViews14d\",\n \"purchasesClicks14d\",\n \"newToBrandPurchases14d\",\n \"newToBrandPurchasesViews14d\",\n \"newToBrandPurchasesClicks14d\",\n \"newSubscribeAndSave14d\",\n \"newSubscribeAndSaveViews14d\",\n \"newSubscribeAndSaveClicks14d\",\n \"addToWatchlist14d\",\n \"addToWatchlistViews14d\",\n \"addToWatchlistClicks14d\",\n \"downloadedVideoPlays14d\",\n \"downloadedVideoPlaysViews14d\",\n \"downloadedVideoPlaysClicks14d\",\n \"videoStreams14d\",\n \"videoStreamsViews14d\",\n \"videoStreamsClicks14d\",\n \"playTrailers14d\",\n \"playTrailersViews14d\",\n \"playerTrailersClicks14d\",\n \"rentals14d\",\n \"rentalsViews14d\",\n \"rentalsClicks14d\",\n \"videoDownloads14d\",\n \"videoDownloadsViews14d\",\n \"videoDownloadsClicks14d\",\n \"videoStart\",\n \"videoFirstQuartile\",\n \"videoMidpoint\",\n \"videoThirdQuartile\",\n \"videoComplete\",\n \"videoPause\",\n \"videoResume\",\n \"videoMute\",\n \"videoUnmute\",\n \"unitsSold14d\",\n \"sales14d\",\n \"newToBrandUnitsSold14d\",\n \"newToBrandProductSales14d\",\n \"brandSearch14d\",\n \"brandSearchViews14d\",\n \"brandSearchClicks14d\",\n \"brandSearchRate14d\",\n \"brandSearchCPA14d\",\n \"grossImpressions\",\n \"grossClickThroughs\",\n \"invalidImpressions\",\n \"invalidClickThroughs\",\n \"invalidImpressionRate\",\n \"invalidClickThroughsRate\",\n \"offAmazonProductSales14d\",\n \"offAmazonUnitsSold14d\",\n \"totalPurchases14d\",\n \"totalPurchasesViews14d\",\n \"totalPurchasesClicks14d\",\n \"totalSales14d\",\n \"totalUnitsSold14d\",\n \"combinedPurchases\",\n \"combinedPurchasesViews\",\n \"combinedPurchasesClicks\",\n \"combinedProductSales\",\n \"combinedUnitsSold\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 20:20:07 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "194" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "DKEYHZG9APRAQ66S94Q0" }, { "key": "x-amzn-RequestId", "value": "357edcde-bbdb-4879-9fc5-66bc3ccbd93d" }, { "key": "x-amzn-Remapped-Content-Length", "value": "194" }, { "key": "x-amz-apigw-id", "value": "d362jEc9IAMFvQg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63aca4f7-7d88fbaf7052ffacc33e5839" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 20:20:06 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"f4c2ad32-32dc-c54c-c4a2-c03127f74459\",\n \"type\": \"TECHNOLOGY\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-12-28T21:20:07.236Z\"\n}" }, { "name": "Geography", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2022-12-21\",\n \"endDate\": \"2022-12-27\",\n \"type\": \"GEOGRAPHY\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\",\n \"COUNTRY\",\n \"STATE_COUNTY_REGION\",\n \"CITY\",\n \"DMA\",\n \"POSTAL_CODE\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 20:22:56 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "193" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CSEYQ7JGYPM5Q9V0V7ZB" }, { "key": "x-amzn-RequestId", "value": "2eb1287a-9cae-42fd-914b-bb6daba10b8a" }, { "key": "x-amzn-Remapped-Content-Length", "value": "193" }, { "key": "x-amz-apigw-id", "value": "d37Q-E9FoAMF9xw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63aca5a0-7e5c127281845e9ef70f6d6f" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 20:22:56 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"32c2ad33-7ca1-b83b-7ce5-05cd92bef026\",\n \"type\": \"GEOGRAPHY\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-12-28T21:22:56.081Z\"\n}" }, { "name": "Conversion source", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspcreatereports.v3+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2022-12-21\",\n \"endDate\": \"2022-12-27\",\n \"type\": \"CONVERSION_SOURCE\",\n \"dimensions\": [\n \"ORDER\",\n \"LINE_ITEM\",\n \"CREATIVE\"\n ],\n \"metrics\": [\n \"totalPurchases14d\",\n \"totalPurchasesViews14d\",\n \"totalPurchasesClicks14d\",\n \"totalSales14d\",\n \"totalUnitsSold14d\",\n \"offAmazonPurchases14d\",\n \"offAmazonPurchasesViews14d\",\n \"offAmazonPurchasesClicks14d\",\n \"offAmazonProductSales14d\",\n \"offAmazonUnitsSold14d\",\n \"combinedPurchases\",\n \"combinedPurchasesViews\",\n \"combinedPurchasesClicks\",\n \"combinedProductSales\",\n \"combinedUnitsSold\"\n ]\n}" }, "url": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 28 Dec 2022 22:06:09 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspcreatereports.v3+json" }, { "key": "Content-Length", "value": "201" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "AJRR599BDDS0DQEEEBX8" }, { "key": "x-amzn-RequestId", "value": "a1e19252-bbeb-4379-8524-7ef2a8bb250a" }, { "key": "x-amzn-Remapped-Content-Length", "value": "201" }, { "key": "x-amz-apigw-id", "value": "d4KYnHshoAMFwBQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63acbdd1-8c0c51206be6afad64794108" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 28 Dec 2022 22:06:08 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"reportId\": \"cac2ad62-bc47-86ed-515a-1cf579ec8366\",\n \"type\": \"CONVERSION_SOURCE\",\n \"format\": \"JSON\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In progress\",\n \"location\": \"\",\n \"expiration\": \"2022-12-28T23:06:09.048Z\"\n}" } ] }, { "name": "DSP report status", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"Response should return status\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspgetreports.v3+json", "type": "text" } ], "url": { "raw": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "accounts", "{{dspAccountId}}", "dsp", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "response": [ { "name": "DSP report status", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.dspgetreports.v3+json", "type": "text" } ], "url": { "raw": "{{api_url}}/accounts/{{dspAccountId}}/dsp/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "accounts", "{{dspAccountId}}", "dsp", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 25 May 2022 17:25:18 GMT" }, { "key": "Content-Type", "value": "application/vnd.dspgetreports.v3+json" }, { "key": "Content-Length", "value": "580" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "PZXYCVEJEQ5X6CWKSWC6" }, { "key": "x-amzn-RequestId", "value": "5c3dd01b-4f62-4a33-ab24-f4e5ef8bfe93" }, { "key": "x-amzn-Remapped-Content-Length", "value": "580" }, { "key": "x-amz-apigw-id", "value": "SsTzvFUroAMF7iw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-628e667e-fca2eb3eb78e9dbe1254e8ee" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 25 May 2022 17:25:18 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"reportId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"type\": \"CAMPAIGN\",\n \"format\": \"JSON\",\n \"status\": \"SUCCESS\",\n \"statusDetails\": \"Success\",\n \"location\": \"https://corvo-reports.s3.amazonaws.com/DSP_API/2022-05-25/{{reportID}}/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"expiration\": \"2022-05-25T18:25:18.290Z\"\n}" } ] } ], "description": "Note that you must set the `dspAccountId` variable in your Postman environment to use the requests in this folder.\n\n[Read full documentation.](https://advertising.amazon.com/API/docs/en-us/dsp-reports-beta-3p/#/Reports)", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Sponsored ads V3", "item": [ { "name": "Create report", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'PENDING') {", " postman.setEnvironmentVariable(\"reportId\", response.reportId);", " console.log('reportId = ' + pm.environment.get(\"reportId\"));", "}", "else {", " console.log('Error requesting report with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP campaigns report 7/5-7/10\",\n \"startDate\":\"2023-09-05\",\n \"endDate\":\"2023-09-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"campaign\",\"adGroup\"],\n \"columns\":[\"adGroupId\",\"campaignId\", \"impressions\", \"clicks\", \"cost\", \"purchases1d\", \"purchases7d\", \"purchases14d\", \"purchases30d\",\"date\"],\n \"reportTypeId\":\"spCampaigns\",\n \"timeUnit\":\"DAILY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "response": [ { "name": "SP daily campaign report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP campaigns report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"campaign\",\"adGroup\"],\n \"columns\":[\"adGroupId\",\"campaignId\", \"impressions\", \"clicks\", \"cost\", \"purchases1d\", \"purchases7d\", \"purchases14d\", \"purchases30d\",\"date\"],\n \"reportTypeId\":\"spCampaigns\",\n \"timeUnit\":\"DAILY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 25 Jul 2022 22:44:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "621" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "3MRNMXMXJ3R24YS514W6" }, { "key": "x-amzn-RequestId", "value": "93527d0d-bc5a-4e91-8278-0eac5de5717c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "d9e4ad77-0289-45a4-aa3a-982cfd6e46e5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "621" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "V2FzgFaEIAMFkAQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62df1ce3-4d921758c811a1e7feb4860e" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 25 Jul 2022 22:44:50 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"impressions\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"date\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"campaign\",\n \"adGroup\"\n ],\n \"reportTypeId\": \"spCampaigns\",\n \"timeUnit\": \"DAILY\"\n },\n \"createdAt\": \"2022-07-25T22:44:51.223Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP campaigns report 7/5-7/10\",\n \"reportId\": \"06ba6494-8568-4066-949f-abb6a91c0b9c\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-25T22:44:51.223Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "SP daily search term report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP search term report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"searchTerm\"],\n \"columns\":[\"adGroupId\",\"campaignId\", \"keywordId\",\"targeting\",\"searchTerm\",\"impressions\", \"clicks\", \"cost\", \"purchases1d\", \"purchases7d\", \"purchases14d\", \"purchases30d\",\"date\"],\n \"reportTypeId\":\"spSearchTerm\",\n \"timeUnit\":\"DAILY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 25 Jul 2022 22:53:05 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "653" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EX4Q5D56YFKS6BKS7S30" }, { "key": "x-amzn-RequestId", "value": "f0ffbb3e-af42-494b-991e-56fe5caf5263" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "e648815c-1d37-4ca2-b3e8-ff0c3380cb80" }, { "key": "x-amzn-Remapped-Content-Length", "value": "653" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "V2HAzEz6IAMFcxA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62df1ed1-0dbbb0b0f076496373115cc3" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 25 Jul 2022 22:53:05 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"keywordId\",\n \"targeting\",\n \"searchTerm\",\n \"impressions\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"date\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"searchTerm\"\n ],\n \"reportTypeId\": \"spSearchTerm\",\n \"timeUnit\": \"DAILY\"\n },\n \"createdAt\": \"2022-07-25T22:53:05.884Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP search term report 7/5-7/10\",\n \"reportId\": \"0034fb06-812c-4cad-ba88-ea7b1d51777d\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-25T22:53:05.884Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "SP summary advertised product report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP advertised product report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"advertiser\"],\n \"columns\":[\"adGroupId\",\"campaignId\", \"adId\", \"impressions\", \"advertisedAsin\", \"advertisedSku\",\"clicks\", \"cost\", \"purchases1d\", \"purchases7d\", \"purchases14d\", \"purchases30d\",\"startDate\",\"endDate\"],\n \"reportTypeId\":\"spAdvertisedProduct\",\n \"timeUnit\":\"SUMMARY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 25 Jul 2022 22:55:27 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "687" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "C5XY5HYRJ2NFAPH0WW3D" }, { "key": "x-amzn-RequestId", "value": "1ac05092-9414-495a-9362-5c0991534c0f" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "cce093cf-8036-42bb-85a4-10ba14135adc" }, { "key": "x-amzn-Remapped-Content-Length", "value": "687" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "V2HW6FvXIAMFVpg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62df1f5f-f0ee00b11941dd9d07fa74f3" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 25 Jul 2022 22:55:27 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"adId\",\n \"impressions\",\n \"advertisedAsin\",\n \"advertisedSku\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"startDate\",\n \"endDate\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"advertiser\"\n ],\n \"reportTypeId\": \"spAdvertisedProduct\",\n \"timeUnit\": \"SUMMARY\"\n },\n \"createdAt\": \"2022-07-25T22:55:27.349Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP advertised product report 7/5-7/10\",\n \"reportId\": \"46d057fe-ae05-4cfc-b384-b896ce0663ff\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-25T22:55:27.349Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "SP daily purchased product report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP purchased product report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"asin\"],\n \"columns\":[\"adGroupId\",\"campaignId\", \"purchasedAsin\", \"advertisedAsin\",\"sales1d\",\"sales7d\",\"salesOtherSku1d\",\"salesOtherSku7d\"],\n \"reportTypeId\":\"spPurchasedProduct\",\n \"timeUnit\":\"DAILY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 25 Jul 2022 23:29:13 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "616" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "PRDKAZKE90P9W0N5S90J" }, { "key": "x-amzn-RequestId", "value": "51436de5-0900-48a2-8ce8-74583b800571" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "a4f8bafe-82e8-4d80-b2d1-dd58c22715d7" }, { "key": "x-amzn-Remapped-Content-Length", "value": "616" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "V2MThGMUIAMF7Yg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62df2749-dd8a91827c31d4abe2a879a3" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 25 Jul 2022 23:29:12 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"purchasedAsin\",\n \"advertisedAsin\",\n \"sales1d\",\n \"sales7d\",\n \"salesOtherSku1d\",\n \"salesOtherSku7d\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"asin\"\n ],\n \"reportTypeId\": \"spPurchasedProduct\",\n \"timeUnit\": \"DAILY\"\n },\n \"createdAt\": \"2022-07-25T23:29:13.625Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP purchased product report 7/5-7/10\",\n \"reportId\": \"f92d4127-d3e8-4203-beea-6597cbe84a7d\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-25T23:29:13.625Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "SB daily purchased product report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SB purchased product report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_BRANDS\",\n \"groupBy\":[\"purchasedAsin\"],\n \"columns\":[\"adGroupName\",\"campaignName\", \"purchasedAsin\", \"productName\", \"sales14d\", \"orders14d\",\"date\"],\n \"reportTypeId\":\"sbPurchasedProduct\",\n \"timeUnit\":\"DAILY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 25 Jul 2022 23:29:57 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "598" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1GVWD98B9KP725PSNM81" }, { "key": "x-amzn-RequestId", "value": "d1e7c487-d183-4cdf-938e-a8440b179f53" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "b45ff4b7-e20c-48ea-ab6b-c05b75bb5c47" }, { "key": "x-amzn-Remapped-Content-Length", "value": "598" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "V2MaXF80IAMFTIQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62df2775-79fe39e1b0c8928ac8e9af93" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 25 Jul 2022 23:29:56 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_BRANDS\",\n \"columns\": [\n \"adGroupName\",\n \"campaignName\",\n \"purchasedAsin\",\n \"productName\",\n \"sales14d\",\n \"orders14d\",\n \"date\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"purchasedAsin\"\n ],\n \"reportTypeId\": \"sbPurchasedProduct\",\n \"timeUnit\": \"DAILY\"\n },\n \"createdAt\": \"2022-07-25T23:29:57.484Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SB purchased product report 7/5-7/10\",\n \"reportId\": \"b8129e20-c14e-43c3-a47f-a25462f41641\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-25T23:29:57.484Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "SP summary targeting report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP targeting report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"targeting\"],\n \"columns\":[\"adGroupId\",\"campaignId\", \"targeting\",\"keywordId\",\"matchType\",\"impressions\", \"clicks\", \"cost\", \"purchases1d\", \"purchases7d\", \"purchases14d\", \"purchases30d\",\"startDate\",\"endDate\"],\n \"filters\": [\n {\n \"field\": \"keywordType\",\n \"values\": [\n \"TARGETING_EXPRESSION\",\n \"TARGETING_EXPRESSION_PREDEFINED\"\n ]\n }\n ],\n \"reportTypeId\":\"spTargeting\",\n \"timeUnit\":\"SUMMARY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 29 Jul 2022 17:36:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "754" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "PP0SFX0MJC1JTAKA7NKP" }, { "key": "x-amzn-RequestId", "value": "852fd169-b715-4193-91b0-5adc11c9a61f" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "104d9b5d-c1f3-4ea0-9220-3a0e56dd9ddd" }, { "key": "x-amzn-Remapped-Content-Length", "value": "754" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "WCkcvE-1IAMFobw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62e41ab7-21ee28ed5d1f6d35f7c1bf65" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 29 Jul 2022 17:36:55 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"targeting\",\n \"keywordId\",\n \"matchType\",\n \"impressions\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"startDate\",\n \"endDate\"\n ],\n \"filters\": [\n {\n \"field\": \"keywordType\",\n \"values\": [\n \"TARGETING_EXPRESSION\",\n \"TARGETING_EXPRESSION_PREDEFINED\"\n ]\n }\n ],\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"targeting\"\n ],\n \"reportTypeId\": \"spTargeting\",\n \"timeUnit\": \"SUMMARY\"\n },\n \"createdAt\": \"2022-07-29T17:36:55.891Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP targeting report 7/5-7/10\",\n \"reportId\": \"d1be6fa2-fa70-4a61-9e17-135b6d2c6be3\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-29T17:36:55.891Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "SP summary keywords report", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"name\":\"SP keywords report 7/5-7/10\",\n \"startDate\":\"2022-07-05\",\n \"endDate\":\"2022-07-10\",\n \"configuration\":{\n \"adProduct\":\"SPONSORED_PRODUCTS\",\n \"groupBy\":[\"targeting\"],\n \"columns\":[\"adGroupId\",\"campaignId\",\"keywordId\",\"matchType\",\"keyword\",\"impressions\", \"clicks\", \"cost\", \"purchases1d\", \"purchases7d\", \"purchases14d\", \"purchases30d\",\"startDate\",\"endDate\"],\n \"filters\": [\n {\n \"field\": \"keywordType\",\n \"values\": [\n \"BROAD\",\n \"PHRASE\",\n \"EXACT\"\n ]\n }\n ],\n \"reportTypeId\":\"spTargeting\",\n \"timeUnit\":\"SUMMARY\",\n \"format\":\"GZIP_JSON\"\n }\n }" }, "url": "{{api_url}}/reporting/reports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 29 Jul 2022 18:45:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "719" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "NZTSXK3FNH45DQGS0BXE" }, { "key": "x-amzn-RequestId", "value": "4208313a-361f-4273-90f1-08cff76358c4" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "7ee10c3f-b56f-4c1f-983a-8369a6830443" }, { "key": "x-amzn-Remapped-Content-Length", "value": "719" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.createasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "WCueZFQ7oAMFWfA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62e42ac2-08582de6157660552caf0904" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 29 Jul 2022 18:45:22 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"keywordId\",\n \"matchType\",\n \"keyword\",\n \"impressions\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"startDate\",\n \"endDate\"\n ],\n \"filters\": [\n {\n \"field\": \"keywordType\",\n \"values\": [\n \"BROAD\",\n \"PHRASE\",\n \"EXACT\"\n ]\n }\n ],\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"targeting\"\n ],\n \"reportTypeId\": \"spTargeting\",\n \"timeUnit\": \"SUMMARY\"\n },\n \"createdAt\": \"2022-07-29T18:45:22.628Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP keywords report 7/5-7/10\",\n \"reportId\": \"a94dfcb9-7528-4f93-a0dd-425ce29bf843\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-29T18:45:22.628Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" } ] }, { "name": "Report status", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/reporting/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "reporting", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "response": [ { "name": "Pending status", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/reporting/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "reporting", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 29 Jul 2022 18:57:53 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "621" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "VSJJ3BRF242B2YK3CFW5" }, { "key": "x-amzn-RequestId", "value": "6f4114e0-5813-4304-8487-cbeedb550f9a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "8a150da2-2969-45e2-8b13-173e8b16cf83" }, { "key": "x-amzn-Remapped-Content-Length", "value": "621" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.getasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "WCwTxFbUIAMF7Rw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62e42db1-35af1cb18910de2e53d46fdb" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 29 Jul 2022 18:57:53 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"impressions\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"date\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"campaign\",\n \"adGroup\"\n ],\n \"reportTypeId\": \"spCampaigns\",\n \"timeUnit\": \"DAILY\"\n },\n \"createdAt\": \"2022-07-29T18:57:50.547Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": null,\n \"generatedAt\": null,\n \"name\": \"SP campaigns report 7/5-7/10\",\n \"reportId\": \"b09d780d-44d8-425c-a3fc-c6aa51e91b39\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"PENDING\",\n \"updatedAt\": \"2022-07-29T18:57:50.547Z\",\n \"url\": null,\n \"urlExpiresAt\": null\n}" }, { "name": "Complete status", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/vnd.createasyncreportrequest.v3+json", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/reporting/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "reporting", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 29 Jul 2022 19:44:45 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "2616" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "G7PWP7DV4F55V22AP1ME" }, { "key": "x-amzn-RequestId", "value": "d8eb6457-15f6-4fa5-b464-dacf494f797c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "c8f5d2b5-62a0-4eba-b488-a4313c7e6cd7" }, { "key": "x-amzn-Remapped-Content-Length", "value": "2616" }, { "key": "x-amzn-Remapped-x-amzn-Remapped-Content-Type", "value": "application/vnd.getasyncreportresponse.v3+json" }, { "key": "x-amz-apigw-id", "value": "WC3LFEGQIAMF0jw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62e438ad-3ea5e60ef75c24118943a829" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 29 Jul 2022 19:44:44 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"configuration\": {\n \"adProduct\": \"SPONSORED_PRODUCTS\",\n \"columns\": [\n \"adGroupId\",\n \"campaignId\",\n \"impressions\",\n \"clicks\",\n \"cost\",\n \"purchases1d\",\n \"purchases7d\",\n \"purchases14d\",\n \"purchases30d\",\n \"date\"\n ],\n \"filters\": null,\n \"format\": \"GZIP_JSON\",\n \"groupBy\": [\n \"campaign\",\n \"adGroup\"\n ],\n \"reportTypeId\": \"spCampaigns\",\n \"timeUnit\": \"DAILY\"\n },\n \"createdAt\": \"2022-07-29T18:57:50.547Z\",\n \"endDate\": \"2022-07-10\",\n \"failureReason\": null,\n \"fileSize\": 22,\n \"generatedAt\": \"2022-07-29T18:59:45.758Z\",\n \"name\": \"SP campaigns report 7/5-7/10\",\n \"reportId\": \"b09d780d-44d8-425c-a3fc-c6aa51e91b39\",\n \"startDate\": \"2022-07-05\",\n \"status\": \"COMPLETED\",\n \"updatedAt\": \"2022-07-29T18:59:45.758Z\",\n \"url\": \"https://offline-report-storage-us-east-1-prod.s3.amazonaws.com/b09d780d-44d8-425c-a3fc-c6aa51e91b39-1659121105347/report-b09d780d-44d8-425c-a3fc-c6aa51e91b39-1659121105347.json.gz?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEML%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCICaVrClpLhvyTwFPv%2Bdx6xkOT4nNVr896Vm26Zze3Wn6AiEA%2FVXwrVfwF5w%2BfKTJbm5W%2BpoPM7BBVe8NmxB0FDFareEq4QUIGxABGgw4NDE2NDU1NDMwNzQiDMe0CJ541BqnRTI67iq%2BBWgAvrE8KSR6zoPnpU9cX3IKYHEASgrHiturj95UmxyrWVn%2Feq2qhjUX4EKfQKZBDTPFlG75IdaAo%2FxP%2BpCmbo7tF1YFApg2hkTjtACIRDZkC%2BL0B9Ek%2FT60Rwh1q2%2B2QJC8E4SJF%2B4ArP%2Fi0p7vmEOjudfMLIv9e3WxjFaZXF3SbqkJcxTWGMQVUm2G19eh1ch%2FX6xIiyhKpyZ023CK637NkEHddums8a%2FFeRbtH8es2kRo5Co5fmKiY2RpaJYp6q7oQU6Z6LXfkJ0SLMuyYWSx3qgnK79lhU5v6sXMKjU%2FzFNTEsNO18IT2z3g%2BrFyz2Y4l3A5W%2FkCbYdMcyz1ccMsK2bJbE%2B3NIM6CbfS4rK1crHFpXHv6ualU18v9rxQMKtMx%2Fk5L9dx6EkJr9vY%2BYIl%2FdaaTVe4SlBQiqn%2BRqVEnwppJF9T%2BMprSpQHGxwkDU0kFrp5hPZVAmkV%2BvMq3ovbCeiN14SHgb7WyNkT3g7gx3iRbJ3WQ%2FnXUej7m7lDPrDTSBh2uGD2AAGSQxItM25BRxd0oMwW9IRzT3C5EptQU3qEeA2App4AOdlRNSlFcqL0yZ1t3qlemj3i5w7obepRWAznbZQI7h1pB1RktFsfX3%2BfKEyGCX0aGe7C5yDWIaGYIdRtfI91tDFy1hcX01gDlTN%2Boh1oHH8ycLvbsfaDRt7WkM02hAJQ1ajjNWGxwcN7qLAhWIP%2FheeorOby%2BhuDTmPUehSxKdiHxMHOXwxxQEDg9P7U%2FJ3Vj%2F4Lle9derOVNjdoXoY9PnERF9ZZ8SSShsTEpbOVESwLvv4go9Ep13lcZKiXigdytgxbIXI%2Fjdiag9eIrA5uumrx78tiaA4tiV4vktRr9WVmcf9ZxC7zDvnxsXPU%2FtfMtkf3N58QW5P1%2Ft%2BaYZYuv1rgqAx7gr4QBGKk8RSp1j3dpo2NLDCBvpCXBjqpASuflSAExdCgWB0cQPazGRXrmD1HHCV7tX9BNYQyjXnvoBA2cw%2BC%2Fu8VyWJHNy4p5i6Jm3K552lWVY9ZG%2B8hc5tlunEv72lP22FAeiZuuBnZtWwv%2B8MK3FPkpQgZ%2BX5lAWXMnpLy%2BivnK%2Bdpr6CMxRhu6QJwt64t4ObOy%2FqjZWf5QS7Bdbj2kz0VAjmp3pNl%2Fn7NEWUizeoiFXMmu%2BTusD9RSxy6IVWDzj8%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220729T194445Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIA4H5P3Z2RPG762ONW%2F20220729%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ba4e54b67a4111e0ef5fcf2e2153ab7d88a1257eba7beeb9961f15d1cf756cc\",\n \"urlExpiresAt\": \"2022-07-29T20:44:45.388887Z\"\n}" } ] } ] }, { "name": "Sponsored ads V2", "item": [ { "name": "Request SB report", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"Response should return reportId\", function () {", " pm.response.to.not.be.error;", "});", "", "/**Sets the returned reportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"reportId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"reportId\", response.reportId);", " console.log('reportId = ' + pm.environment.get(\"reportId\"));", "}", "else {", " console.log('Error requesting report with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"reportDate\":\"{{date}}\",\n \"metrics\":\"impressions,clicks,cost,attributedSales14d,attributedConversions14d\"\n}" }, "url": { "raw": "{{api_url}}/v2/hsa/:recordType/report", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", ":recordType", "report" ], "variable": [ { "key": "recordType", "value": "{{recordType}}" } ] } }, "response": [ { "name": "Campaign report (video)", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"reportDate\":\"20220210\",\n \"metrics\":\"impressions,clicks,cost,attributedSales14d,attributedConversions14d\",\n \"creativeType\":\"video\"\n}" }, "url": { "raw": "{{api_url}}/v2/hsa/:recordType/report", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", ":recordType", "report" ], "variable": [ { "key": "recordType", "value": "campaigns" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "plain", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:04:30 GMT" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7H9R13RS3C9G805AJ5GD" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\"reportId\":\"amzn1.clicksAPI.v1.p1.xxxxxxxxxxxxxx\",\"recordType\":\"campaign\",\"status\":\"IN_PROGRESS\",\"statusDetails\":\"Report is being generated.\"}" }, { "name": "Placement report", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"reportDate\":\"20220210\",\n \"metrics\":\"impressions,clicks,cost,attributedSales14d,attributedConversions14d\",\n \"segment\":\"placement\"\n}" }, "url": { "raw": "{{api_url}}/v2/hsa/:recordType/report", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", ":recordType", "report" ], "variable": [ { "key": "recordType", "value": "campaigns" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "plain", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:03:34 GMT" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "NA52PG23YJ6TJDVG1GAC" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\"reportId\":\"amzn1.clicksAPI.v1.p1.xxxxxxxxxxxxx\",\"recordType\":\"campaign\",\"status\":\"IN_PROGRESS\",\"statusDetails\":\"Report is being generated.\"}" } ] }, { "name": "Request SD report", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"Response should return reportId\", function () {", " pm.response.to.not.be.error;", "});", "", "/**Sets the returned reportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"reportId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"reportId\", response.reportId);", " console.log('reportId = ' + pm.environment.get(\"reportId\"));", " ", "}", "else {", " console.log('Error requesting report with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"reportDate\": \"{{date}}\",\n \"metrics\": \"impressions,clicks,cost,attributedDetailPageView14d\",\n \"tactic\": \"T00030\"\n}" }, "url": { "raw": "{{api_url}}/v2/sd/:recordType/report", "host": [ "{{api_url}}" ], "path": [ "v2", "sd", ":recordType", "report" ], "variable": [ { "key": "recordType", "value": "{{recordType}}" } ] } }, "response": [ { "name": "Campaign report (product targeting)", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"reportDate\": \"20220210\",\n \"metrics\": \"campaignId,impressions,clicks,cost\",\n \"tactic\": \"T00030\"\n}" }, "url": { "raw": "{{api_url}}/v2/sd/:recordType/report", "host": [ "{{api_url}}" ], "path": [ "v2", "sd", ":recordType", "report" ], "variable": [ { "key": "recordType", "value": "campaigns" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:06:16 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ZQQZ2P1NE4XRV6JYDDV3" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"reportId\": \"amzn1.sdAPI.v1.p1.62153428.c07f01eb-2fec-4296-acd2-611208606c30\",\n \"recordType\": \"campaigns\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"Report is being generated.\"\n}" }, { "name": "Product ad report (audience targeting)", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"reportDate\": \"20220210\",\n \"metrics\": \"adId,impressions,clicks,cost\",\n \"tactic\": \"T00030\"\n}" }, "url": { "raw": "{{api_url}}/v2/sd/:recordType/report", "host": [ "{{api_url}}" ], "path": [ "v2", "sd", ":recordType", "report" ], "variable": [ { "key": "recordType", "value": "productAds" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:07:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "X41V5W3CFBWTSW17BSH4" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"reportId\": \"amzn1.sdAPI.v1.p1.6215347E.d8949d61-ef32-49ff-b043-73515a2a5634\",\n \"recordType\": \"productAds\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"Report is being generated.\"\n}" } ] }, { "name": "Report status", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"Response should return status\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "v2", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "response": [ { "name": "In progress", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "v2", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:09:26 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EXFMZ0VHKD0Q9NTB6EF4" }, { "key": "x-amz-request-id", "value": "EXFMZ0VHKD0Q9NTB6EF4" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"reportId\": \"amzn1.clicksAPI.v1.p1.xxxxxxxxxxx\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"Report generation is in progress.\"\n}" }, { "name": "Complete", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/reports/:reportId", "host": [ "{{api_url}}" ], "path": [ "v2", "reports", ":reportId" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:17:17 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "SVV9411Y1ME1FX16X01P" }, { "key": "x-amz-request-id", "value": "SVV9411Y1ME1FX16X01P" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"reportId\": \"amzn1.clicksAPI.v1.p1.xxxxxxxxxxxxxx\",\n \"status\": \"SUCCESS\",\n \"statusDetails\": \"Report has been successfully generated.\",\n \"location\": \"https://advertising-api.amazon.com/v1/reports/amzn1.clicksAPI.v1.p1.xxxxxxxxxxxxxx/download\",\n \"fileSize\": 222,\n \"expiration\": 1653350400000\n}" } ] }, { "name": "Download report", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"Response should return status\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/reports/:reportId/download", "host": [ "{{api_url}}" ], "path": [ "v2", "reports", ":reportId", "download" ], "variable": [ { "key": "reportId", "value": "{{reportId}}" } ] } }, "response": [] } ], "description": "**Note**: Use Sponsored ads V3 reporting endpoints to request SP reports." } ] }, { "name": "Snapshots", "item": [ { "name": "Sponsored Products", "item": [ { "name": "Request SP snapshot", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned snapshotId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"snapshotId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"snapshotId\", response.snapshotId);", " console.log('snapshotId = ' + pm.environment.get(\"snapshotId\"));", "", " /**Sets GET snapshot status as the next request */", " postman.setNextRequest(\"SP snapshot status\")", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n}" }, "url": { "raw": "{{api_url}}/v2/sp/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "{{recordType}}" } ] } }, "response": [ { "name": "Ad group snapshot", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"stateFilter\": \"enabled,paused\"\n}" }, "url": { "raw": "{{api_url}}/v2/sp/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "adGroups" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:14:08 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "A5AH8DN6FFFQ4J2KACHF" }, { "key": "x-amz-request-id", "value": "A5AH8DN6FFFQ4J2KACHF" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.clicksAPI.v1.p1.xxxxxxxxxxx\",\n \"recordType\": \"adGroup\",\n \"status\": \"IN_PROGRESS\"\n}" }, { "name": "Target snapshot", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n}" }, "url": { "raw": "{{api_url}}/v2/sp/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "targets" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:14:40 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7TX94YMEAW088DKS4Q3R" }, { "key": "x-amz-request-id", "value": "7TX94YMEAW088DKS4Q3R" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.clicksAPI.v1.p1.xxxxxxxxxxx\",\n \"recordType\": \"targets\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "SP snapshot status", "event": [ { "listen": "test", "script": { "exec": [ "/* If snapshot has finished generating, set next response to \"Download report,\" else wait thirty seconds and check the status again.*/", "const maxNumberOfTries = 5; ", "const sleepBetweenTries = 30000;", "", "const jsonResponse = JSON.parse(responseBody);", "", "if (jsonResponse.status === \"SUCCESS\") {", " postman.setNextRequest(\"Download SP snapshot\");", "} else {", " setTimeout(function() {}, sleepBetweenTries);", " postman.setNextRequest(\"SP snapshot status\");", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/v2/sp/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "response": [ { "name": "Complete", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/sp/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:18:33 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "FJAZ0ZME89AKEZXVK7KY" }, { "key": "x-amz-request-id", "value": "FJAZ0ZME89AKEZXVK7KY" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.clicksAPI.v1.p1.xxxxxxxxxxxxxxx\",\n \"status\": \"SUCCESS\",\n \"statusDetails\": \"Snapshot has been successfully generated.\",\n \"location\": \"https://advertising-api.amazon.com/v1/snapshots/amzn1.clicksAPI.v1.p1.xxxxxxxxxxxxxxx/download\",\n \"fileSize\": 128,\n \"expiration\": 1653350400000\n}" } ] }, { "name": "Download SP snapshot", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/v2/sp/snapshots/:snapshotId/download", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", "snapshots", ":snapshotId", "download" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "response": [ { "name": "Campaign snapshot", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/sp/snapshots/:snapshotId/download", "host": [ "{{api_url}}" ], "path": [ "v2", "sp", "snapshots", ":snapshotId", "download" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "x-amz-id-2", "value": "BHYo4bgxfiGRFqrPh//IE1LXuU0+6js5+6ryuHaKxTg7vPXioHeJGKOjQtj4kUR3jY5jcxoFO+A=" }, { "key": "x-amz-request-id", "value": "B6K1VV5G5X9WPEZ5" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:20:52 GMT" }, { "key": "Last-Modified", "value": "Tue, 22 Feb 2022 19:20:33 GMT" }, { "key": "x-amz-expiration", "value": "expiry-date=\"Tue, 24 May 2022 00:00:00 GMT\", rule-id=\"90 Day Retention Policy\"" }, { "key": "ETag", "value": "\"1b44cb4d27998d6044fdcd0e10ebe40f\"" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Accept-Ranges", "value": "bytes" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Server", "value": "AmazonS3" }, { "key": "Content-Length", "value": "288" } ], "cookie": [], "body": "[\n {\n \"campaignId\": 250761521553085,\n \"name\": \"SpTestCampaign-26/01/2022 15:39:03\",\n \"campaignType\": \"sponsoredProducts\",\n \"targetingType\": \"manual\",\n \"premiumBidAdjustment\": true,\n \"dailyBudget\": 100,\n \"startDate\": \"20220126\",\n \"state\": \"enabled\",\n \"bidding\": {\n \"strategy\": \"autoForSales\",\n \"adjustments\": [\n {\n \"predicate\": \"placementTop\",\n \"percentage\": 50\n }\n ]\n }\n },\n {\n \"campaignId\": 245115598954013,\n \"name\": \"SpTestCampaign-16/11/2021 14:42:49\",\n \"campaignType\": \"sponsoredProducts\",\n \"targetingType\": \"manual\",\n \"premiumBidAdjustment\": true,\n \"dailyBudget\": 100,\n \"startDate\": \"20211116\",\n \"state\": \"enabled\",\n \"bidding\": {\n \"strategy\": \"autoForSales\",\n \"adjustments\": [\n {\n \"predicate\": \"placementTop\",\n \"percentage\": 50\n }\n ]\n }\n }\n]" } ] } ], "description": "See the [Amazon Ads API reference](https://advertising.amazon.com/API/docs/en-us/sponsored-products/2-0/openapi#/Snapshots) for full Sponsored Products snapshot documentation." }, { "name": "Sponsored Display", "item": [ { "name": "Request SD snapshot", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned snapshotId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"snapshotId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"snapshotId\", response.snapshotId);", " console.log('snapshotId = ' + pm.environment.get(\"snapshotId\"));", "", " /**Sets GET snapshot status as the next request */", " postman.setNextRequest(\"SD snapshot status\")", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"tactic\":\"T00030\"\n}" }, "url": { "raw": "{{api_url}}/sd/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "sd", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "{{recordType}}" } ] } }, "response": [ { "name": "Target snapshot", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"tactic\":\"T00030\"\n}" }, "url": { "raw": "{{api_url}}/sd/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "sd", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "targets" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:22:18 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "180" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "FBRFTYV4VVTPDDN76W16" }, { "key": "x-amzn-RequestId", "value": "f7f051f8-5945-4d58-95d4-4376245a8ecc" }, { "key": "x-amz-apigw-id", "value": "N9WsnF2_IAMFcXw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-621537ea-9505806191d53bb00da9176d" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.sdAPI.p1.621537EA.d1f99bad-1b84-4623-b444-b65a438e9594\",\n \"recordType\": \"targets\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In the process of generating Snapshot.\"\n}" }, { "name": "Campaign snapshot", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"tactic\":\"T00030\"\n}" }, "url": { "raw": "{{api_url}}/sd/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "sd", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "campaigns" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:23:44 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "182" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "2AMBADZV208GE868HKAD" }, { "key": "x-amzn-RequestId", "value": "ec1604a4-2a9c-4f09-8599-38fc9de912b0" }, { "key": "x-amz-apigw-id", "value": "N9W6GEKHIAMFr2g=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62153840-32b41f79534e65081666274f" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.sdAPI.p1.62153840.4bac962c-5f17-45c0-9f5c-7c9eb5d4d8d1\",\n \"recordType\": \"campaigns\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"In the process of generating Snapshot.\"\n}" } ] }, { "name": "SD snapshot status", "event": [ { "listen": "test", "script": { "exec": [ "/* If report has finished generating, set next response to \"Download report,\" else wait thirty seconds and check the status again.*/", "const maxNumberOfTries = 5; ", "const sleepBetweenTries = 30000;", "", "const jsonResponse = JSON.parse(responseBody);", "", "if (jsonResponse.status === \"SUCCESS\") {", " postman.setNextRequest(\"Download SD snapshot\");", "} else {", " setTimeout(function() {}, sleepBetweenTries);", " postman.setNextRequest(\"SD snapshot status\");", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/sd/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "sd", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "response": [ { "name": "Complete", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "sd", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:22:36 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "351" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "V379RBHV15WYYJHF8H3Q" }, { "key": "x-amzn-RequestId", "value": "b374e84f-ce0c-4069-8da7-4b5864bdb124" }, { "key": "x-amz-apigw-id", "value": "N9WviH4goAMFmjg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-621537fc-f33890747bd1360cfe02bed6" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.sdAPI.p1.xxxxxxxxxxxxxxx\",\n \"recordType\": \"targets\",\n \"status\": \"SUCCESS\",\n \"statusDetails\": \"Snapshot has been successfully generated.\",\n \"location\": \"https://advertising-api.amazon.com/sd/snapshots/xxxxxxxxxxxxxxx/download\",\n \"fileSize\": 188,\n \"expiration\": 1645559538710\n}" } ] }, { "name": "Download SD snapshot", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/sd/snapshots/:snapshotId/download", "host": [ "{{api_url}}" ], "path": [ "sd", "snapshots", ":snapshotId", "download" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "response": [] } ], "description": "See the [Amazon Ads API reference](https://advertising.amazon.com/API/docs/en-us/sponsored-display/3-0/openapi#/Snapshots) for full Sponsored Display snapshot documentation." }, { "name": "Sponsored Brands", "item": [ { "name": "Request SB snapshot", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned snapshotId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"snapshotId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"snapshotId\", response.snapshotId);", " console.log('snapshotId = ' + pm.environment.get(\"snapshotId\"));", "", " /**Sets GET snapshot status as the next request */", " postman.setNextRequest(\"SB snapshot status\")", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n}" }, "url": { "raw": "{{api_url}}/v2/hsa/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "{{recordType}}" } ] } }, "response": [ { "name": "Keyword snapshot", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n}" }, "url": { "raw": "{{api_url}}/v2/hsa/:recordType/snapshot", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", ":recordType", "snapshot" ], "variable": [ { "key": "recordType", "value": "keywords" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:24:33 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "4KMB7J9RNNNFRVY2V0D2" }, { "key": "x-amz-request-id", "value": "4KMB7J9RNNNFRVY2V0D2" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.clicksAPI.v1.p1.62153871.dcc7dcfa-8979-47de-ab33-25b0cfcf81b0\",\n \"recordType\": \"keyword\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "SB snapshot status", "event": [ { "listen": "test", "script": { "exec": [ "/* If snapshot has finished generating, set next response to \"Download report,\" else wait thirty seconds and check the status again.*/", "const maxNumberOfTries = 5; ", "const sleepBetweenTries = 30000;", "", "const jsonResponse = JSON.parse(responseBody);", "", "if (jsonResponse.status === \"SUCCESS\") {", " postman.setNextRequest(\"Download SB snapshot\");", "} else {", " setTimeout(function() {}, sleepBetweenTries);", " postman.setNextRequest(\"SB snapshot status\");", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/v2/hsa/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "response": [ { "name": "In progress", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/hsa/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:24:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "TDT4ZVCJQ01GNBKM93DM" }, { "key": "x-amz-request-id", "value": "TDT4ZVCJQ01GNBKM93DM" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.clicksAPI.v1.p1.62153871.dcc7dcfa-8979-47de-ab33-25b0cfcf81b0\",\n \"status\": \"IN_PROGRESS\",\n \"statusDetails\": \"Snapshot generation is in progress.\"\n}" }, { "name": "Complete", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/hsa/snapshots/:snapshotId", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", "snapshots", ":snapshotId" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:41:12 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "46FZFEZTJDGSTVKE4XGS" }, { "key": "x-amz-request-id", "value": "46FZFEZTJDGSTVKE4XGS" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"snapshotId\": \"amzn1.clicksAPI.v1.p1.xxxxxxxxxx\",\n \"status\": \"SUCCESS\",\n \"statusDetails\": \"Snapshot has been successfully generated.\",\n \"location\": \"https://advertising-api.amazon.com/v1/snapshots/xxxxxxxxxx/download\",\n \"fileSize\": 285,\n \"expiration\": 1653350400000\n}" } ] }, { "name": "Download SB snapshot", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/v2/hsa/snapshots/:snapshotId/download", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", "snapshots", ":snapshotId", "download" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "response": [ { "name": "Keyword snapshot", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "warning": "This is a duplicate header and will be overridden by the Content-Type header generated by Postman.", "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/v2/hsa/snapshots/:snapshotId/download", "host": [ "{{api_url}}" ], "path": [ "v2", "hsa", "snapshots", ":snapshotId", "download" ], "variable": [ { "key": "snapshotId", "value": "{{snapshotId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "x-amz-id-2", "value": "U4TekbEAxJQwJvrmVQdm4IgmWukWdLmmZesuHc84V/2IeJDySpVx3iJjPCPN1beRLoBlbJavaEc=" }, { "key": "x-amz-request-id", "value": "S4HA2MWNJWFQVNKA" }, { "key": "Date", "value": "Tue, 22 Feb 2022 19:41:54 GMT" }, { "key": "Last-Modified", "value": "Tue, 22 Feb 2022 19:31:32 GMT" }, { "key": "x-amz-expiration", "value": "expiry-date=\"Tue, 24 May 2022 00:00:00 GMT\", rule-id=\"90 Day Retention Policy\"" }, { "key": "ETag", "value": "\"218e241e83c48803d5f40428be185788\"" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Accept-Ranges", "value": "bytes" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Server", "value": "AmazonS3" }, { "key": "Content-Length", "value": "285" } ], "cookie": [], "body": "[\n {\n \"keywordId\": 144170583660124565,\n \"adGroupId\": 144264190545297733,\n \"campaignId\": 144208510156081379,\n \"keywordText\": \"rca cable 1637073832215\",\n \"matchType\": \"BROAD\",\n \"state\": \"enabled\",\n \"bid\": 10\n },\n {\n \"keywordId\": 144373194309380055,\n \"adGroupId\": 144293551014439430,\n \"campaignId\": 144128442807713382,\n \"keywordText\": \"dixon ticonderoga 2 pencils\",\n \"matchType\": \"EXACT\",\n \"state\": \"enabled\",\n \"bid\": 0.25\n },\n {\n \"keywordId\": 144371828007013213,\n \"adGroupId\": 144332287029303025,\n \"campaignId\": 144174946579612496,\n \"keywordText\": \"rca cable 1637678068990\",\n \"matchType\": \"BROAD\",\n \"state\": \"enabled\",\n \"bid\": 10\n }\n]" } ] } ], "description": "See the [Amazon Ads API reference](https://advertising.amazon.com/API/docs/en-us/reference/sponsored-brands/2/snapshots) for full Sponsored Brands snapshot documentation." } ] }, { "name": "Test accounts", "item": [ { "name": "Create test account", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "cache-control", "value": "no-cache", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"countryCode\": \"US\",\n \"accountType\": \"AUTHOR\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/testAccounts", "description": "This endpoint requests creation of a new advertising test account based on parameters determined by the JSON request body.\n\nSee [Creating a test account](https://advertising.amazon.com/API/docs/en-us/test-accounts/create-test-accounts#creating-a-test-account) for information on available parameters." }, "response": [] }, { "name": "Check account creation status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" } ], "url": { "raw": "{{api_url}}/testAccounts", "host": [ "{{api_url}}" ], "path": [ "testAccounts" ], "query": [ { "key": "", "value": "", "disabled": true } ] } }, "response": [] } ], "description": "Advertising test accounts do not serve ads or have active billing, allowing Amazon Ads customers to make API requests to test and learn about API functionality.\n\nThe test account creation API allows users to provision an advertising test account, which can then be used to test API functionality.\n\n[Learn more about test accounts.](https://advertising.amazon.com/API/docs/en-us/test-accounts/overview)\n\n## Using test accounts in this collection\n\nAn additional permission scope, `advertising::test:create_account`, is required to use the test account creation API.\n\nTest account creation is disabled for Amazon user accounts that manage genuine advertising accounts.\n\nTo use test accounts with this Postman collection, follow these steps:\n\n1) Create a *new* Amazon user account using an email address to which your development team has access. Note the login credentials. \n2) Create a copy of your Postman environment dedicated to testing, using your Login with Amazon credentials. Change the *current_value* of the `permission_scope` variable to include the additional permission scope, as shown here:\n\n`advertising::campaign_management%20advertising::test:create_account`\n\n3) With the new environment active in Postman, follow the steps in the Auth folder, making sure to sign in with your newly created Amazon user account.\n\nThe access token retrieved by this process will enable your client application to do both of the following on behalf of your test user:\n\n* Create test accounts using the `advertising::test:create_account` permission scope.\n* Use created test accounts to make other requests to the API using the `advertising::campaign_management` permission scope.\n \n\n[Learn more about authorization for test accounts.](https://advertising.amazon.com/API/docs/en-us/test-accounts/authorization-for-test-accounts)\n\nUse this Postman environment when accessing the test account creation API or when testing other requests." }, { "name": "Amazon Marketing Stream", "item": [ { "name": "Create Stream subscription", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"response should return subscriptionId\", function () {", " pm.response.to.not.be.error;", "});", "", "/**Sets the returned subscriptionId as an environment variable */", "postman.clearEnvironmentVariable(\"subscriptionId\");", "var response = JSON.parse(responseBody);", "", "postman.setEnvironmentVariable(\"subscriptionId\", response.subscriptionId);", "console.log('subscriptionId = ' + pm.environment.get(\"subscriptionId\"));", " " ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Accept", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"notes\": \"subscription for sp-traffic\",\n \"clientRequestToken\": \"1234-5678-910-11-12-12-12-12-12\",\n \"dataSetId\": \"sp-traffic\",\n \"destinationArn\": \"arn:aws:sqs:us-east-1:379073720614:EF-Test-2-sp-traffic\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/streams/subscriptions" }, "response": [ { "name": "sp-traffic + SQS", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"clientRequestToken\": \"stream-sp-traffic-test-123456\",\n \"dataSetId\": \"sp-traffic\",\n \"destinationArn\": \"arn:aws:sqs:us-east-1:xxxxxxxxxxxxxxxx\",\n \"notes\": \"sp traffic subscription\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/streams/subscriptions" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" } ], "cookie": [], "body": "{\n \"clientRequestToken\": \"stream-sp-traffic-test-123456\",\n \"subscriptionId\": \"xxxxxxxxxxxxxxx\"\n}" }, { "name": "sp-conversion + SQS", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"clientRequestToken\": \"stream-sp-conversion-test-123456\",\n \"dataSetId\": \"sp-conversion\",\n \"destinationArn\": \"arn:aws:sqs:us-east-1:xxxxxxxxxxxxxxxx\",\n \"notes\": \"sp conversion subscription\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/streams/subscriptions" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" } ], "cookie": [], "body": "{\n \"clientRequestToken\": \"stream-sp-conversion-test-123456\",\n \"subscriptionId\": \"xxxxxxxxxxxxxxx\"\n}" }, { "name": "budget-usage +SQS", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "aliquip cillum officia ea" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "consequat Ut dolore" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"clientRequestToken\": \"stream-budget-usage-test-123456\",\n \"dataSetId\": \"budget-usage\",\n \"destinationArn\": \"arn:aws:sqs:us-east-1:xxxxxxxxxxxxxxxx\",\n \"notes\": \"budget usage subscription\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/streams/subscriptions" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" } ], "cookie": [], "body": "{\n \"clientRequestToken\": \"stream-budget-usage-test-123456\",\n \"subscriptionId\": \"xxxxxxxxxxxxxxx\"\n}" }, { "name": "sp-conversion + Firehose", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Accept", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"clientRequestToken\": \"stringstringstringstri\",\n \"dataSetId\": \"sp-conversion\",\n \"destination\": {\n \"firehoseDestination\": {\n \"deliveryStreamArn\": \"arn:aws:firehose:us-east-1:379073720614:deliverystream/NA-sp-conversion-StreamDestinationFirehoseSpConversionNA\",\n \"subscriptionRoleArn\": \"arn:aws:iam::379073720614:role/NA-sp-conversion-FirehoseSubscriptionRole\",\n \"subscriberRoleArn\": \"arn:aws:iam::379073720614:role/NA-sp-conversion-FirehoseSubscriberRole\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/streams/subscriptions" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 01 May 2024 21:03:47 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "104" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CV02QTEGW2ADTDPMSES4" }, { "key": "x-amzn-RequestId", "value": "819e2bb1-84f1-45ca-bd75-ac2e23a77807" }, { "key": "x-amz-apigw-id", "value": "XHAoDHdRIAMFSfQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6632ae33-c822441a9fb54a1bba1a8969" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"clientRequestToken\": \"stringstringstringstri\",\n \"subscriptionId\": \"amzn1.fead.cs1.kDOCOan12sYjMoSFVNZLHg\"\n}" } ] }, { "name": "List Stream subscriptions", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"response should return subscriptionId\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Accept", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": "{{api_url}}/streams/subscriptions" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Accept", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": "{{api_url}}/streams/subscriptions" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 01 May 2024 20:27:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "940" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "830EGGJG4C1EQA40EY8V" }, { "key": "x-amzn-RequestId", "value": "779d9da2-26d1-439c-950b-35666fcd6f21" }, { "key": "x-amz-apigw-id", "value": "XG7VSGZEIAMFVIA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6632a5bb-689c0bd5aaeb0c7f5181cd8e" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"subscriptions\": [\n {\n \"createdDate\": \"2024-05-01T14:43:19.136Z\",\n \"dataSetId\": \"sp-traffic\",\n \"destination\": {\n \"firehoseDestination\": {\n \"deliveryStreamArn\": \"arn:aws:firehose:us-east-1:xxxxxxx:deliverystream/NA-sp-traffic-sp-traffic-na\",\n \"subscriberRoleArn\": \"arn:aws:iam::xxxxxxx:role/NA-sp-traffic-FirehoseSubscriberRole\",\n \"subscriptionRoleArn\": \"arn:aws:iam::xxxxxxx:role/NA-sp-traffic-FirehoseSubscriptionRole\"\n }\n },\n \"notes\": \"\",\n \"status\": \"ACTIVE\",\n \"subscriptionId\": \"amzn1.fead.cs1.j5VQ2r3VDddWK2e_ArVApg\",\n \"updatedDate\": \"2024-05-01T14:43:23.476Z\"\n },\n {\n \"createdDate\": \"2024-05-01T14:46:26.643Z\",\n \"dataSetId\": \"sp-traffic\",\n \"destination\": {\n \"sqsDestination\": {\n \"queueArn\": \"arn:aws:sqs:us-east-1:xxxxxx:StreamDestinationQueue\"\n }\n },\n \"destinationArn\": \"arn:aws:sqs:us-east-1:xxxxxx:StreamDestinationQueue\",\n \"notes\": \"string\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"subscriptionId\": \"amzn1.fead.cs1.nQHVYtEaQMEqCWGBX31DHQ\",\n \"updatedDate\": \"2024-05-01T14:46:30.02Z\"\n }\n ]\n}" } ] }, { "name": "Get Stream subscription by ID", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"response should return subscriptionId\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Accept", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/streams/subscriptions/:subscriptionId", "host": [ "{{api_url}}" ], "path": [ "streams", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "subscriptionId", "value": "{{subscriptionId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Accept", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "url": { "raw": "{{api_url}}/streams/subscriptions/:subscriptionId", "host": [ "{{api_url}}" ], "path": [ "streams", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "subscriptionId", "value": "{{subscriptionId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 01 May 2024 21:04:57 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "578" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1P20SPM747HAZC236A1D" }, { "key": "x-amzn-RequestId", "value": "98b3080d-5b70-48d8-8316-386fed2bf12a" }, { "key": "x-amz-apigw-id", "value": "XHAzCG6_oAMF5RQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6632ae79-843db2c1b3bfe550d42d0509" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"subscription\": {\n \"createdDate\": \"2024-05-01T21:03:47.714Z\",\n \"dataSetId\": \"sp-conversion\",\n \"destination\": {\n \"firehoseDestination\": {\n \"deliveryStreamArn\": \"arn:aws:firehose:us-east-1:xxxxxxxx:deliverystream/NA-sp-conversion-StreamDestinationFirehoseSpConversionNA\",\n \"subscriberRoleArn\": \"arn:aws:iam::xxxxxxxx:role/NA-sp-conversion-FirehoseSubscriberRole\",\n \"subscriptionRoleArn\": \"arn:aws:iam::xxxxxx:role/NA-sp-conversion-FirehoseSubscriptionRole\"\n }\n },\n \"notes\": \"\",\n \"status\": \"ACTIVE\",\n \"subscriptionId\": \"amzn1.fead.cs1.kDOCOan12sYjMoSFVNZLHg\",\n \"updatedDate\": \"2024-05-01T21:03:50.027Z\"\n }\n}" } ] }, { "name": "Update Stream subscription", "event": [ { "listen": "test", "script": { "exec": [ "/*Tests that response is not an error*/", "pm.test(\"response should return subscriptionId\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"notes\": \"Only ACTIVE subscriptions can be archived\",\n \"status\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/streams/subscriptions/:subscriptionId", "host": [ "{{api_url}}" ], "path": [ "streams", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "subscriptionId", "value": "{{subscriptionId}}" } ] } }, "response": [ { "name": "Archive subscription", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account.", "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}" }, { "description": "(Required) The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.", "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}" }, { "key": "Content-Type", "value": "application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"notes\": \"Change status of subscription\",\n \"status\": \"ARCHIVED\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/streams/subscriptions/:subscriptionId", "host": [ "{{api_url}}" ], "path": [ "streams", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "subscriptionId", "value": "{{subscriptionId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 05 Jul 2022 21:45:39 GMT" }, { "key": "Content-Type", "value": "text/plain" }, { "key": "Content-Length", "value": "0" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "HZ669J1F0ZN9WV3YHR3P" }, { "key": "x-amz-apigw-id", "value": "c2090393aed164a76ba8d75f13180ad5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{}" } ] } ], "description": "Full API reference available in the [advanced tools center](https://advertising.amazon.com/API/docs/en-us/amazon-marketing-stream/openapi)." }, { "name": "Sponsored Products", "item": [ { "name": "Campaigns", "item": [ { "name": "List campaigns", "event": [ { "listen": "test", "script": { "exec": [ "/*Save campaignId from first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No campaigns were returned.\");", "} else {", "", " if(responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " var campaignId = response.campaigns[0].campaignId", " postman.clearEnvironmentVariable(\"campaignId\");", " postman.setEnvironmentVariable(\"campaignId\", campaignId); ", " console.log(\"campaignId from first campaign object is \" + campaignId);", " } else {", " console.log(responseBody);", " }", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10\n}" }, "url": "{{api_url}}/sp/campaigns/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10\n}" }, "url": "{{api_url}}/sp/campaigns/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 02 Nov 2022 19:25:17 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "998" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "2JJPN1KG2CGCNZ70V44X" }, { "key": "x-amzn-RequestId", "value": "09c0d3fb-7b55-431d-a8ad-571fd1dd154f" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "8374f8ea-9dab-4456-9395-3f3eedd3d067" }, { "key": "x-amzn-Remapped-Content-Length", "value": "998" }, { "key": "x-amz-apigw-id", "value": "a_OUkFjIIAMFU4A=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6362c41d-1424d71dc7c9b560c7e86867" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 02 Nov 2022 19:25:17 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": [\n {\n \"budget\": {\n \"budget\": 15,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"52978233888897\",\n \"dynamicBidding\": {\n \"placementBidding\": [],\n \"strategy\": \"AUTO_FOR_SALES\"\n },\n \"name\": \"Campaign - 8/11/2022 11:28:51\",\n \"premiumBidAdjustment\": false,\n \"startDate\": \"2022-08-11\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"AUTO\"\n },\n {\n \"budget\": {\n \"budget\": 100,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"276748589410145\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"endDate\": \"2022-11-08\",\n \"name\": \"Test SP campaign\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-10-31\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"AUTO\"\n },\n {\n \"budget\": {\n \"budget\": 100,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"62077673972552\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 50,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"AUTO_FOR_SALES\"\n },\n \"name\": \"SpTestCampaign-11/08/2022 15:32:07#l6p7828r590\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-08-11\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"MANUAL\"\n }\n ],\n \"totalResults\": 3\n}" } ] }, { "name": "Create campaigns", "event": [ { "listen": "test", "script": { "exec": [ "/* Save campaignId to environment */", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var campaignId = response.campaigns.success[0].campaignId", "postman.clearEnvironmentVariable(\"campaignId\");", "postman.setEnvironmentVariable(\"campaignId\", campaignId); ", " console.log(\"campaignId is \" + campaignId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"endDate\": \"2022-12-08\",\n \"name\": \"manualAccount\",\n \"targetingType\": \"MANUAL\",\n \"state\": \"ENABLED\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"startDate\": \"2022-11-30\",\n \"budget\": {\n \"budgetType\": \"DAILY\",\n \"budget\": 1000\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaigns" }, "response": [ { "name": "Manual campaign", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"endDate\": \"2022-12-08\",\n \"name\": \"Test manual\",\n \"targetingType\": \"MANUAL\",\n \"state\": \"ENABLED\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"startDate\": \"2022-11-30\",\n \"budget\": {\n \"budgetType\": \"DAILY\",\n \"budget\": 1000\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 02 Nov 2022 19:26:48 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "428" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EXPSCKDJFADDZCQZSFE5" }, { "key": "x-amzn-RequestId", "value": "6e976a85-a5bf-45cc-9cf8-dfe5c696f217" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "4df4d3c1-9c88-45ed-8d84-d6ce376767ed" }, { "key": "x-amzn-Remapped-Content-Length", "value": "428" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "a_Oi0Et3IAMFuNw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6362c478-2597597b005af042b93638dc" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 02 Nov 2022 19:26:48 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"budget\": {\n \"budget\": 1000,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"95980739749507\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"endDate\": \"2022-12-08\",\n \"name\": \"Test manual\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-11-30\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"MANUAL\"\n },\n \"campaignId\": \"95980739749507\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Auto campaigns", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"endDate\": \"2022-12-08\",\n \"name\": \"Test manual\",\n \"targetingType\": \"AUTO\",\n \"state\": \"ENABLED\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"startDate\": \"2022-11-30\",\n \"budget\": {\n \"budgetType\": \"DAILY\",\n \"budget\": 1000\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 02 Nov 2022 19:27:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "428" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "0BNJ94Q3G7KF21KG7G5P" }, { "key": "x-amzn-RequestId", "value": "c7a3e509-0815-41a7-9f45-7513a4b01e1b" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "cc197f04-f0fe-459c-89b4-fbb0898091ed" }, { "key": "x-amzn-Remapped-Content-Length", "value": "428" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "a_Ot9HIuIAMF43Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6362c4bf-df8d01e02145ba8f5a9df942" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 02 Nov 2022 19:27:59 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"budget\": {\n \"budget\": 1000,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"187199434001281\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"endDate\": \"2022-12-08\",\n \"name\": \"Test manual\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-11-30\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"AUTO\"\n },\n \"campaignId\": \"187199434001281\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Delete campaigns", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/campaigns/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/campaigns/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 02 Nov 2022 19:27:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "80" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "76V6CGMWA1X4APRTBFC0" }, { "key": "x-amzn-RequestId", "value": "2456d322-94bd-4685-b069-09d425056349" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "4f932725-dd9f-47f1-964d-d910ae65979d" }, { "key": "x-amzn-Remapped-Content-Length", "value": "80" }, { "key": "x-amz-apigw-id", "value": "a_OqwGhcoAMF5Jw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6362c4ab-cf24e4d4498d9b27a1712b42" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 02 Nov 2022 19:27:39 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaignId\": \"95980739749507\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Update campaigns", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"state\": \"PAUSED\",\n \"campaignId\": \"{{campaignId}}\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/campaigns" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaign.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaign.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"status\": \"PAUSED\",\n \"campaignId\": \"{{campaignId}}\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 02 Nov 2022 19:28:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "428" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EBN7AHXF4GDRAH7QYVE5" }, { "key": "x-amzn-RequestId", "value": "f7904f2b-7689-405a-a70f-9850f5337636" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "cde1f7ec-e928-4dbd-9b86-1e3390a6fdd5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "428" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "a_O2kGsVIAMFljw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6362c4f6-6987deb1bda892e5685b60e2" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 02 Nov 2022 19:28:54 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"budget\": {\n \"budget\": 1000,\n \"budgetType\": \"DAILY\"\n },\n \"campaignId\": \"187199434001281\",\n \"dynamicBidding\": {\n \"placementBidding\": [\n {\n \"percentage\": 900,\n \"placement\": \"PLACEMENT_TOP\"\n }\n ],\n \"strategy\": \"LEGACY_FOR_SALES\"\n },\n \"endDate\": \"2022-12-08\",\n \"name\": \"Test manual\",\n \"premiumBidAdjustment\": true,\n \"startDate\": \"2022-11-30\",\n \"state\": \"ENABLED\",\n \"targetingType\": \"AUTO\"\n },\n \"campaignId\": \"187199434001281\",\n \"index\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Ad groups", "item": [ { "name": "Create ad groups", "event": [ { "listen": "test", "script": { "exec": [ "if(responseCode.code === 207) {", " var result = JSON.parse(responseBody);", " var adGroupId = result.adGroups.success[0].adGroup.adGroupId;", " postman.clearEnvironmentVariable(\"adGroupId\");", " pm.environment.set(\"adGroupId\", adGroupId); ", " console.log(\"adGroupId is \" + adGroupId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"adGrouptesting333\",\n \"defaultBid\": 100,\n \"state\": \"ENABLED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"adGroupTest\",\n \"defaultBid\": 100,\n \"state\": \"ENABLED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 12 Aug 2022 16:44:57 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "140" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "R8MZC4CVW3MZVH41RTDB" }, { "key": "x-amzn-RequestId", "value": "e9c9ee2f-66dd-42ff-941c-af35e7def4d1" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "ff97f9e0-e01c-4641-91b8-f87a65bd38ee" }, { "key": "x-amzn-Remapped-Content-Length", "value": "140" }, { "key": "x-amz-apigw-id", "value": "Wwl9eH6-oAMF7mw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f68389-2ce8809a64d5133bf7f60368" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 12 Aug 2022 16:44:57 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"adGroups\": {\n \"error\": [],\n \"success\": [\n {\n \"adGroup\": {\n \"adGroupId\": \"38308592845076\",\n \"name\": \"adGroupTest\"\n },\n \"adGroupId\": \"38308592845076\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Delete ad groups", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:00:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "79" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "WTHWZXAWSTNAX1BS2AVD" }, { "key": "x-amzn-RequestId", "value": "64bda82b-049e-468c-be44-b796b4d11925" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "9eb706c3-59aa-4f93-99c9-fe4884d5aba9" }, { "key": "x-amzn-Remapped-Content-Length", "value": "79" }, { "key": "x-amz-apigw-id", "value": "YhpqiHw8oAMFUqg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323bca9-4c026badf1fa45fbb61b11ed" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:00:41 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"adGroups\": {\n \"error\": [],\n \"success\": [\n {\n \"adGroupId\": \"245296632705339\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "List ad groups", "event": [ { "listen": "test", "script": { "exec": [ "/*Save adGroupId from first adGroup object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No adGroups were returned\");", "} else {", "if(responseCode.code === 200) {", " var adGroupId = response.adGroups[0].adGroupId;", " postman.clearEnvironmentVariable(\"adGroupId\");", " postman.setEnvironmentVariable(\"adGroupId\", adGroupId); ", " console.log(\"adGroupId from first campaign object is \" + adGroupId);", "} else {", " console.warn(responseBody);", "}", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n },\n \"includeExtendedDataFields\": true,\n \"nameFilter\": {\n \"queryTermMatchType\": \"BROAD_MATCH\",\n \"include\": [\n \"testing\"\n ]\n },\n \"campaignTargetingTypeFilter\": \"AUTO\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n },\n \"includeExtendedDataFields\": true,\n \"nameFilter\": {\n \"queryTermMatchType\": \"BROAD_MATCH\",\n \"include\": [\n \"testing\"\n ]\n },\n \"campaignTargetingTypeFilter\": \"AUTO\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:06:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "467" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CHAESQTT6T57QD9D5P17" }, { "key": "x-amzn-RequestId", "value": "d5b891c3-f13c-46ef-8af5-600feff07e94" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "cf7f7c1f-e1ef-462b-8328-1b7b8355c264" }, { "key": "x-amzn-Remapped-Content-Length", "value": "467" }, { "key": "x-amz-apigw-id", "value": "Yhqk8GqLIAMFtYA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323be1f-be0e4a78cc496f1b08915b45" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:06:55 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"adGroups\": [\n {\n \"adGroupId\": \"220795965021387\",\n \"campaignId\": \"102579222643121\",\n \"defaultBid\": 100,\n \"extendedData\": {\n \"creationDate\": 1663286608515,\n \"creationDateTime\": \"2022-09-16T00:03:28.515Z\",\n \"lastUpdateDate\": 1663286608515,\n \"lastUpdateDateTime\": \"2022-09-16T00:03:28.515Z\",\n \"servingStatus\": \"PENDING_START_DATE\",\n \"statusReasons\": [\n \"PENDING_START_DATE_DETAIL\",\n \"CAMPAIGN_INCOMPLETE_DETAIL\",\n \"AD_GROUP_INCOMPLETE_DETAIL\"\n ]\n },\n \"name\": \"adGrouptesting\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalResults\": 1\n}" } ] }, { "name": "Update ad groups", "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"name\": \"SPTestUpdate\",\n \"state\": \"PAUSED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"defaultBid\": 200\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups" }, "response": [ { "name": "Change name", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spAdGroup.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spAdGroup.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"name\": \"SPTestUpdate\",\n \"state\": \"PAUSED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"defaultBid\": 200\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/adGroups" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:07:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "143" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "5QJD58J2Y6FC9RVY7V1M" }, { "key": "x-amzn-RequestId", "value": "97020ba9-0235-4ec6-be88-b4b07467e8d3" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "34f42077-c7ec-4a6b-a30a-7debda961c55" }, { "key": "x-amzn-Remapped-Content-Length", "value": "143" }, { "key": "x-amz-apigw-id", "value": "Yhqu7EoPoAMFgeQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323be5f-67d40545a22389a00c87d9d5" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:07:59 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"adGroups\": {\n \"error\": [],\n \"success\": [\n {\n \"adGroup\": {\n \"adGroupId\": \"220795965021387\",\n \"name\": \"SPTestUpdate\"\n },\n \"adGroupId\": \"220795965021387\",\n \"index\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Product ads", "item": [ { "name": "List product ads", "event": [ { "listen": "test", "script": { "exec": [ "/* Save adId of first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No productAds were returned\");", "} else {", "if(responseCode.code === 200) {", "var adId = response.productAds[0].adId;", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);", " console.info(\"adId from first productAd object is \" + adId);", "} else {", " console.warn(responseBody);", "}", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "url": "{{api_url}}/sp/productAds/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "url": "{{api_url}}/sp/productAds/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 11 Aug 2022 15:02:47 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "256" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "BD2DN0XSF03J7VBJ0T8H" }, { "key": "x-amzn-RequestId", "value": "8f34eb63-c620-4834-8a75-5d7c60d9a051" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "851b03a0-3b12-4026-aee1-e8337e608684" }, { "key": "x-amzn-Remapped-Content-Length", "value": "256" }, { "key": "x-amz-apigw-id", "value": "WtEDsEQ9oAMF5-Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f51a17-011283e01d61b6f3a9d6c0e4" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 11 Aug 2022 15:02:47 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"productAds\": [\n {\n \"adGroupId\": \"140531465119624\",\n \"adId\": \"87094400667825\",\n \"asin\": \"B0986YK83J\",\n \"campaignId\": \"26256301417055\",\n \"extendedData\": {\n \"creationDate\": 1652879836672,\n \"lastUpdateDate\": 1652879836672\n },\n \"sku\": \"a140aafa-1a23\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalResults\": 1\n}" } ] }, { "name": "Create product ads", "event": [ { "listen": "test", "script": { "exec": [ "/* Save adId of first object to environment*/", "", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var adId = response.productAds.success[0].adId;", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId); ", "console.info(\"adId is \" + adId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"productAds\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"state\": \"ENABLED\",\n \"asin\": \"B087TKYT4X\",\n \"adGroupId\": \"{{adGroupId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/productAds" }, "response": [ { "name": "Seller", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"productAds\": [\n {\n \"campaignId\": \"26256301417055\",\n \"state\": \"ENABLED\",\n \"sku\": \"a140aafa-1a23\",\n \"adGroupId\": \"140531465119624\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/productAds" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 11 Aug 2022 15:21:36 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "312" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "YCF9W3CA33MM7V65HE0T" }, { "key": "x-amzn-RequestId", "value": "f09207c3-2897-479c-8049-7ac5a960e160" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "899e0968-d680-49c6-9c57-4a469ea2f8a1" }, { "key": "x-amzn-Remapped-Content-Length", "value": "312" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "WtG0DHx6IAMFltQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f51e80-dcedbec3f2bd342318c8b536" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 11 Aug 2022 15:21:35 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"productAds\": {\n \"error\": [],\n \"success\": [\n {\n \"adId\": \"237832642498121\",\n \"index\": 0,\n \"productAd\": {\n \"adGroupId\": \"140531465119624\",\n \"adId\": \"237832642498121\",\n \"asin\": \"B0986YK83J\",\n \"campaignId\": \"26256301417055\",\n \"extendedData\": {\n \"creationDate\": 1660231296423,\n \"lastUpdateDate\": 1660231296423\n },\n \"sku\": \"a140aafa-1a23\",\n \"state\": \"ENABLED\"\n }\n }\n ]\n }\n}" }, { "name": "Vendor", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"productAds\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"state\": \"ENABLED\",\n \"asin\": \"B087TKYT4X\",\n \"adGroupId\": \"{{adGroupId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/productAds" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 02 Nov 2022 15:31:09 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "323" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "MZVEVV6Y91W22CR4TZXA" }, { "key": "x-amzn-RequestId", "value": "01c94862-91f2-42dc-8360-c942062e53eb" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "93217fbb-12bb-45c1-b779-3e939dbda4d1" }, { "key": "x-amzn-Remapped-Content-Length", "value": "323" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "a-sBmGyAoAMFtGg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63628d3d-550666638158388202ba4a96" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 02 Nov 2022 15:31:09 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"productAds\": {\n \"error\": [],\n \"success\": [\n {\n \"adId\": \"249769698386528\",\n \"index\": 0,\n \"productAd\": {\n \"adGroupId\": \"36453868083101\",\n \"adId\": \"249769698386528\",\n \"asin\": \"B087TKYT4X\",\n \"campaignId\": \"52978233888897\",\n \"extendedData\": {\n \"creationDateTime\": \"2022-11-02T15:31:09.471Z\",\n \"lastUpdateDateTime\": \"2022-11-02T15:31:09.471Z\"\n },\n \"state\": \"ENABLED\"\n }\n }\n ]\n }\n}" } ] }, { "name": "Update product ad", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"productAds\": [\n {\n \"adId\": \"{{adId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/productAds" }, "response": [ { "name": "Pause ad", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"productAds\": [\n {\n \"adId\": \"182771240295320\",\n \"state\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/productAds" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 11 Aug 2022 15:36:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "289" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1QESP2HDPZYFRB350EKC" }, { "key": "x-amzn-RequestId", "value": "d6e2f459-2bc6-4668-ad4b-9819026c490b" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3f2bc3d9-4124-4ca9-bba3-e661783c9a0b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "289" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "WtJBDETKIAMF1Xg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f52207-d3f89a1e3907b746fce33772" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 11 Aug 2022 15:36:39 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"productAds\": {\n \"error\": [],\n \"success\": [\n {\n \"adId\": \"182771240295320\",\n \"index\": 0,\n \"productAd\": {\n \"adGroupId\": \"220500883239512\",\n \"adId\": \"182771240295320\",\n \"asin\": \"B087TKYT4X\",\n \"campaignId\": \"62077673972552\",\n \"extendedData\": {\n \"creationDate\": 1660232105944,\n \"lastUpdateDate\": 1660232198949\n },\n \"state\": \"PAUSED\"\n }\n }\n ]\n }\n}" } ] }, { "name": "Delete product ads", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Tpe", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adIdFilter\": {\n \"include\": [\n \"{{adId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/productAds/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spProductAd.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spProductAd.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adIdFilter\": {\n \"include\": [\n \"87094400667825\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/productAds/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 11 Aug 2022 15:20:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "75" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "Z2EF2ZCW83WRQXXM89S5" }, { "key": "x-amzn-RequestId", "value": "974c568e-281d-4afe-a4b2-42ec0ea93caa" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "6a47900f-912f-4aa2-b22f-5f18dd495ada" }, { "key": "x-amzn-Remapped-Content-Length", "value": "75" }, { "key": "x-amz-apigw-id", "value": "WtGrrFMaoAMF7dA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f51e4a-30c415298b9303bbcc9a0e8e" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 11 Aug 2022 15:20:42 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"productAds\": {\n \"error\": [],\n \"success\": [\n {\n \"adId\": \"87094400667825\",\n \"index\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Product targeting", "item": [ { "name": "List targets", "event": [ { "listen": "test", "script": { "exec": [ "/* Save targetId of first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No targeting clauses were returned\");", "} else {", "if(responseCode.code === 200) {", "var targetId = response.targetingClauses[0].targetId", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);", " console.info(\"targetId from first targeting clause object is \" + targetId);", "} else {", " console.warn(responseBody);", "}", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/targets/list" }, "response": [ { "name": "List targets with campaign filter", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/targets/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 24 Aug 2022 02:25:20 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "996" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1CVYXG3ZZMCAE4WW533H" }, { "key": "x-amzn-RequestId", "value": "8232df7e-95d8-483a-899e-8666846418a7" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "9f3f878c-b30f-4bb1-b334-79b278f650d5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "996" }, { "key": "x-amz-apigw-id", "value": "XWLRWFRkoAMFlwQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63058c08-85c6f39ea913c7fdfe5e01da" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 24 Aug 2022 02:25:11 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"targetingClauses\": [\n {\n \"adGroupId\": \"184667233956202\",\n \"campaignId\": \"42586816713082\",\n \"expression\": [\n {\n \"type\": \"QUERY_HIGH_REL_MATCHES\"\n }\n ],\n \"expressionType\": \"AUTO\",\n \"resolvedExpression\": [\n {\n \"type\": \"QUERY_HIGH_REL_MATCHES\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"31667521455534\"\n },\n {\n \"adGroupId\": \"184667233956202\",\n \"campaignId\": \"42586816713082\",\n \"expression\": [\n {\n \"type\": \"QUERY_BROAD_REL_MATCHES\"\n }\n ],\n \"expressionType\": \"AUTO\",\n \"resolvedExpression\": [\n {\n \"type\": \"QUERY_BROAD_REL_MATCHES\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"275709419154538\"\n },\n {\n \"adGroupId\": \"184667233956202\",\n \"campaignId\": \"42586816713082\",\n \"expression\": [\n {\n \"type\": \"ASIN_ACCESSORY_RELATED\"\n }\n ],\n \"expressionType\": \"AUTO\",\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_ACCESSORY_RELATED\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"54866135241200\"\n },\n {\n \"adGroupId\": \"184667233956202\",\n \"campaignId\": \"42586816713082\",\n \"expression\": [\n {\n \"type\": \"ASIN_SUBSTITUTE_RELATED\"\n }\n ],\n \"expressionType\": \"AUTO\",\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SUBSTITUTE_RELATED\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"14640417682469\"\n }\n ],\n \"totalResults\": 4\n}" } ] }, { "name": "Create targets", "event": [ { "listen": "test", "script": { "exec": [ "/* Save targetId of first object to environment*/", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var targetId = response.targetingClauses.success[0].targetId", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId); ", "console.info(\"targetId is \" + targetId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetingClauses\": [\n {\n \"expression\": [\n {\n \"type\":\"ASIN_CATEGORY_SAME_AS\",\n \"value\":\"2522102011\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"7048034011\"\n }\n ],\n \"campaignId\": \"{{campaignId}}\",\n \"expressionType\": \"MANUAL\",\n \"state\": \"ENABLED\",\n \"bid\": 1.50,\n \"adGroupId\": \"{{adGroupId}}\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/targets" }, "response": [ { "name": "Product targeting", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetingClauses\": [\n {\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07FKDZPZW\"\n }\n ],\n \"campaignId\": \"26256301417055\",\n \"expressionType\": \"MANUAL\",\n \"state\": \"ENABLED\",\n \"bid\": 1.50,\n \"adGroupId\": \"169462822148652\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/targets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 11 Aug 2022 17:31:46 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "377" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EHD5876ECXF239AFKCHY" }, { "key": "x-amzn-RequestId", "value": "ba1d92f5-8dbe-4413-bbec-53d146d40004" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "c8f75a93-fd34-487f-97c8-eab5de6acbb5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "377" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "WtZ4cGp5oAMF8Qg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f53d02-61d0182f5f0b5a204eb12c6a" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 11 Aug 2022 17:31:46 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"targetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"targetId\": \"269280454302686\",\n \"targetingClause\": {\n \"adGroupId\": \"169462822148652\",\n \"bid\": 1.5,\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07FKDZPZW\"\n }\n ],\n \"expressionType\": \"MANUAL\",\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07FKDZPZW\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"269280454302686\"\n }\n }\n ]\n }\n}" }, { "name": "Brand targeting", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetingClauses\": [\n {\n \"expression\": [\n {\n \"type\":\"ASIN_CATEGORY_SAME_AS\",\n \"value\":\"2522102011\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"7048034011\"\n }\n ],\n \"campaignId\": \"26256301417055\",\n \"expressionType\": \"MANUAL\",\n \"state\": \"ENABLED\",\n \"bid\": 1.50,\n \"adGroupId\": \"169462822148652\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/targets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 07 Sep 2022 19:20:26 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "503" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "K5HVXV9G6NSGA8PETHR4" }, { "key": "x-amzn-RequestId", "value": "cf76c425-bb5e-43c4-8f77-d710f4a8b0a8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "a0037263-a299-4439-ba18-68a2955426ee" }, { "key": "x-amzn-Remapped-Content-Length", "value": "503" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "YGpHDFBjoAMFsLQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6318eefa-343228b5767b96f7850f7232" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 07 Sep 2022 19:20:26 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" } ], "cookie": [], "body": "{\n \"targetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"targetId\": \"110461451438424\",\n \"targetingClause\": {\n \"adGroupId\": \"169462822148652\",\n \"bid\": 1.5,\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_CATEGORY_SAME_AS\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"7048034011\"\n }\n ],\n \"expressionType\": \"MANUAL\",\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_CATEGORY_SAME_AS\",\n \"value\": \"Paper Dolls\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"Back to Basics\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"110461451438424\"\n }\n }\n ]\n }\n}" }, { "name": "Category targeting with refinements", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetingClauses\": [\n {\n \"expression\": [\n {\n \"type\":\"ASIN_CATEGORY_SAME_AS\",\n \"value\":\"2522102011\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"ASIN_REVIEW_RATING_BETWEEN\",\n \"value\": \"3-4.5\"\n }\n ],\n \"campaignId\": \"26256301417055\",\n \"expressionType\": \"MANUAL\",\n \"state\": \"ENABLED\",\n \"bid\": 1.50,\n \"adGroupId\": \"169462822148652\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/targets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 07 Sep 2022 19:24:30 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "611" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JYAMHX2V37WP0BPGH1QF" }, { "key": "x-amzn-RequestId", "value": "42a9fbaf-ab4e-4210-8e97-60c0a2ce639c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "b7505061-4255-445a-92fe-6cd276bfa7b5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "611" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "YGptRGO7IAMFhcQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6318efee-a97529f3c1b9d055f3e7a2e4" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 07 Sep 2022 19:24:30 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" } ], "cookie": [], "body": "{\n \"targetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"targetId\": \"243130187002275\",\n \"targetingClause\": {\n \"adGroupId\": \"169462822148652\",\n \"bid\": 1.5,\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_CATEGORY_SAME_AS\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"ASIN_REVIEW_RATING_BETWEEN\",\n \"value\": \"3-4.5\"\n }\n ],\n \"expressionType\": \"MANUAL\",\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_CATEGORY_SAME_AS\",\n \"value\": \"Paper Dolls\"\n },\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"Back to Basics\"\n },\n {\n \"type\": \"ASIN_REVIEW_RATING_BETWEEN\",\n \"value\": \"3-4.5\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"243130187002275\"\n }\n }\n ]\n }\n}" } ] }, { "name": "Update targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetingClauses\": [\n {\n \"targetId\": \"{{targetId}}\",\n \"bid\": 3.25\n }\n ]\n}" }, "url": "{{api_url}}/sp/targets" }, "response": [ { "name": "Update bid", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetingClauses\": [\n {\n \"targetId\": \"{{targetId}}\",\n \"bid\": 3.25\n }\n ]\n}" }, "url": "{{api_url}}/sp/targets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 24 Aug 2022 02:28:17 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "352" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "F63WSB5Z1X3113ZWBAGK" }, { "key": "x-amzn-RequestId", "value": "e06883a4-873b-48ba-b16e-b545f91af343" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "58bc2282-833c-483c-8b9d-ab5674ddee55" }, { "key": "x-amzn-Remapped-Content-Length", "value": "352" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "XWLuOFThoAMFVig=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63058cc1-cb572a0a4888f4ab71869f78" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 24 Aug 2022 02:28:16 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"targetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"targetId\": \"31667521455534\",\n \"targetingClause\": {\n \"adGroupId\": \"184667233956202\",\n \"bid\": 3.25,\n \"campaignId\": \"42586816713082\",\n \"expression\": [\n {\n \"type\": \"QUERY_HIGH_REL_MATCHES\"\n }\n ],\n \"expressionType\": \"AUTO\",\n \"resolvedExpression\": [\n {\n \"type\": \"QUERY_HIGH_REL_MATCHES\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"31667521455534\"\n }\n }\n ]\n }\n}" } ] }, { "name": "Delete targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetIdFilter\": {\n \"include\": [\n \"{{targetId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/targets/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targetIdFilter\": {\n \"include\": [\n \"106987722228654\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/targets/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 12 Aug 2022 16:11:36 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "86" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "PYS5CE95AB9WJ8TQF3NB" }, { "key": "x-amzn-RequestId", "value": "883a6fef-fc4f-4965-bf42-5e29a8a2d9d7" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "66478a8d-9fae-479c-9a93-e425093f8ce3" }, { "key": "x-amzn-Remapped-Content-Length", "value": "86" }, { "key": "x-amz-apigw-id", "value": "WwhEzFXeIAMFmvg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-62f67bb8-ce0450a27aa6d41abf3a1e9e" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 12 Aug 2022 16:11:36 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"targetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"targetId\": \"106987722228654\"\n }\n ]\n }\n}" } ] }, { "name": "Product recommendatios", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spproductrecommendationresponse.asins.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adAsins\": [\n \"B09LJWZT6G\"\n ],\n \"locale\": \"en_US\",\n \"count\": 1,\n \"cursor\": \"{{cursorId}}\"\n}" }, "url": "{{api_url}}/sp/targets/products/recommendations" }, "response": [ { "name": "ASINs", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true }, { "key": "Accept", "value": "application/vnd.spproductrecommendationresponse.asins.v3+json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"adAsins\": [\n \"B09LJWZT6G\"\n ],\n \"count\": \"5\",\n \"locale\": \"en_US\"\n}" }, "url": "{{api_url}}/sp/targets/products/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 25 Aug 2022 20:36:54 GMT" }, { "key": "Content-Type", "value": "application/vnd.spproductrecommendationresponse.asins.v3+json" }, { "key": "Content-Length", "value": "528" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "K4TKH1E6PR239XVAZ929" }, { "key": "x-amzn-RequestId", "value": "ea47602a-e0ff-4187-b6c8-2c4e86e86d58" }, { "key": "x-amz-apigw-id", "value": "Xb-H8HMOoAMF6rg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6307dd66-4365fceabaa194d7b466afc3" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"recommendations\": [\n {\n \"recommendedAsin\": \"B08YJY5KW5\",\n \"themes\": [\n \"Similar items (frequently viewed together)\"\n ]\n },\n {\n \"recommendedAsin\": \"B09TGKBFCM\",\n \"themes\": [\n \"Similar items (frequently viewed together)\"\n ]\n },\n {\n \"recommendedAsin\": \"B01LL9ITX8\",\n \"themes\": [\n \"Similar items (frequently viewed together)\"\n ]\n },\n {\n \"recommendedAsin\": \"B07C8RCNXD\",\n \"themes\": [\n \"Similar items (frequently viewed together)\"\n ]\n },\n {\n \"recommendedAsin\": \"B06XWRGMVT\",\n \"themes\": [\n \"Similar items (frequently viewed together)\"\n ]\n }\n ],\n \"nextCursor\": \"h9oGnf2jn2qd3ymV4nWLsA==\",\n \"previousCursor\": null\n}" }, { "name": "Themes", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true }, { "key": "Accept", "value": "application/vnd.spproductrecommendationresponse.themes.v3+json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"adAsins\": [\n \"B09LJWZT6G\"\n ],\n \"locale\": \"en_US\"\n}" }, "url": "{{api_url}}/sp/targets/products/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 25 Aug 2022 20:38:02 GMT" }, { "key": "Content-Type", "value": "application/vnd.spproductrecommendationresponse.themes.v3+json" }, { "key": "Content-Length", "value": "3605" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EEAST77Z6G12FND5BRHA" }, { "key": "x-amzn-RequestId", "value": "89befcd9-d9f8-4492-ae75-7c1a1fbf5022" }, { "key": "x-amz-apigw-id", "value": "Xb-SkHxjIAMFW9w=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6307ddaa-2f465c1a8f4950ec875a1799" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"recommendations\": [\n {\n \"theme\": \"Similar items (frequently viewed together)\",\n \"description\": \"Items that shoppers frequently view and click along with your advertised item during a shopping session.\",\n \"recommendedAsins\": [\n \"B08YJY5KW5\",\n \"B09TGKBFCM\",\n \"B01LL9ITX8\",\n \"B07C8RCNXD\",\n \"B06XWRGMVT\",\n \"B09TK2394N\",\n \"B07BF9VW77\",\n \"B09TT7R9MC\",\n \"B0716FGHB6\",\n \"B0002V310I\",\n \"B0932NSH7D\",\n \"B07WV49Q56\",\n \"B095LBFZPD\",\n \"B0955LTTLC\",\n \"B08PZLJ6Y8\",\n \"B09GPCB2XX\",\n \"B09YDDW6VZ\",\n \"B09NBBDLCB\",\n \"B0892J7D57\",\n \"B099G8JRLZ\",\n \"B00GOMDGOA\",\n \"B08D22XC8M\",\n \"B07PWBF6BS\",\n \"B0B4FZ31VB\",\n \"B09LRTSPRT\",\n \"B099QV15NM\",\n \"B07FHBS9NN\",\n \"B09876NXSN\",\n \"B07JB4RWCN\",\n \"B00NVAJSIQ\",\n \"B089BSPM6T\",\n \"B09R4JL4QV\",\n \"B097KHTMT5\",\n \"B09898Y6SH\",\n \"B084R3H4PD\",\n \"B00TKL13DS\",\n \"B099QWWL3V\",\n \"B077GDQQYG\",\n \"B08GSMB6DG\",\n \"B08X6VGVN5\",\n \"B01A5U3N5S\",\n \"B08YJ4ZPGK\",\n \"B09WQYHTF1\",\n \"B07G98R2NT\",\n \"B0921LCGLR\",\n \"B0894W5W8N\",\n \"B014D3KJWI\",\n \"B07KBLNZ7H\",\n \"B09B4QD42W\",\n \"B075ZTR9TT\",\n \"B07DQDM5ML\",\n \"B09K6BXGFP\",\n \"B09JMQVH64\",\n \"B09FPG4FZZ\",\n \"B09RNVSPGW\",\n \"B0B3DV4PRM\",\n \"B07GSDXP7Y\",\n \"B0948H6Q9R\",\n \"B09Q7VQNRY\",\n \"B08664M5ZF\",\n \"B07WRX6YJN\",\n \"B09V2BS8RH\",\n \"B09C5Z4359\",\n \"B07GRPRB7K\",\n \"B07V1PKTVG\",\n \"B07FCCPDVG\",\n \"B07BRR59DY\",\n \"B07V3LMNF3\",\n \"B014D3KL0S\",\n \"B099PL97T9\",\n \"B09FR11S3Z\",\n \"B087R7L78R\",\n \"B09TLM53P7\",\n \"B08N6FYFL6\",\n \"B091K1C3KD\",\n \"B08QYLJSLN\",\n \"B07F6271HL\",\n \"B0B4MS8P21\",\n \"B09R9VP1JN\",\n \"B07YTPQT8R\",\n \"B09927G7VS\",\n \"B073ZKX19J\",\n \"B07PRBQN9Z\",\n \"B07BQG32M5\",\n \"B0924G3JM8\",\n \"B0723CZFP6\",\n \"B012BEEEUY\",\n \"B08KVLRRC3\",\n \"B08L5BG9W6\",\n \"B096RGM8G7\",\n \"B08RB6R194\",\n \"B08JSK2738\",\n \"B0136KPDYI\",\n \"B094DYTVRZ\",\n \"B095NPJHH6\",\n \"B096C761GK\",\n \"B093SRPT75\",\n \"B07ZZV722J\",\n \"B0B2RMW87M\",\n \"B09L66177X\",\n \"B076ZHDZ2H\",\n \"B08LVH9VTC\",\n \"B08FX1Y2R8\",\n \"B00Q0NYPAM\",\n \"B085ZDLQDH\",\n \"B0735RHGGF\",\n \"B00K2TNBY6\",\n \"B07F26L447\",\n \"B078VR4NSH\",\n \"B09KKXF9VQ\",\n \"B09KKMP1WV\",\n \"B08B4J3ZRC\",\n \"B09TW6LDQR\",\n \"B09JXC2TR1\",\n \"B08P5C5VG9\",\n \"B09THPGXW1\",\n \"B09V4Y3JWH\",\n \"B07B1S9V6B\",\n \"B08FTK5SSN\",\n \"B07CF7L8FW\",\n \"B0987JPJMD\",\n \"B09TJRCC9X\",\n \"B09PJC2VBF\",\n \"B09KL48NVN\",\n \"B089FVXF34\",\n \"B09T2R2RQQ\",\n \"B0B3LS2B6T\",\n \"B092QJHX1C\",\n \"B09FDMZHRY\",\n \"B09XJR222T\",\n \"B09TGZVQBN\",\n \"B073ZLG28R\",\n \"B0924GKNFG\",\n \"B0B5C9GLBH\",\n \"B073ZK5YG9\",\n \"B08JVLDYJJ\",\n \"B075P6X29P\",\n \"B08Z7GBRG2\",\n \"B099PFHDMN\",\n \"B077Y6B3ZG\",\n \"B071L1CL6Y\",\n \"B091JZJW63\",\n \"B007A0R7GI\",\n \"B09ZF89HM1\",\n \"B084R3STNV\",\n \"B09S4VP899\",\n \"B09659VNPD\",\n \"B07CL1NNP5\",\n \"B07T4S9W2M\",\n \"B01N5UQRDN\",\n \"B07FPTSHRY\",\n \"B09RGL2FLR\",\n \"B07N4QCJFZ\",\n \"B07S5B1WHJ\",\n \"B07F1WNNBK\",\n \"B08FDZXN4G\",\n \"B0B5KNJSPW\",\n \"B09CNW8TH9\",\n \"B01N4BPBDR\",\n \"B07GVW4YVL\",\n \"B00TE9S92O\",\n \"B098K1FDPZ\",\n \"B071FJDZXG\",\n \"B077YT997W\",\n \"B08PZS722C\",\n \"B09H7FDHSN\",\n \"B0B468WJXR\",\n \"B08N53SX2Y\",\n \"B07DQ71KLW\",\n \"B09Q3B8WZQ\",\n \"B09ZF8SKF8\",\n \"B09YXX3DJ2\",\n \"B00HY900JQ\",\n \"B0716FGMG3\",\n \"B00GC2I08O\",\n \"B01FT68LGY\",\n \"B0B8P2XFH3\",\n \"B09Y8HBVZ5\",\n \"B09MW45WZK\",\n \"B0B67BS8Z9\",\n \"B09KS53FBL\",\n \"B08RYQJLWR\",\n \"B011R3H1S2\",\n \"B08TTP88R9\",\n \"B098255SRY\",\n \"B077Y9PM8J\",\n \"B077JDWC2B\",\n \"B07PMY84ZP\",\n \"B09JZFCG29\",\n \"B09Y54BLLV\",\n \"B084ZTG87G\",\n \"B088FPZ6W3\",\n \"B09HWX4DZV\",\n \"B09QLXSRCH\",\n \"B07R2Z1VVS\",\n \"B09FFVVG7G\",\n \"B09KL9CT6W\",\n \"B07JFPK2DW\",\n \"B09VGMFH9W\",\n \"B08N55CGJJ\",\n \"B08QVV6RBW\",\n \"B08NX9RGSS\",\n \"B0B21G59YK\",\n \"B09MLCBHX4\",\n \"B09KX6B4RW\",\n \"B0886ZG21F\",\n \"B08B4GKJRS\",\n \"B09YQFJRSS\",\n \"B09D2XKYY9\",\n \"B092KTFPMH\",\n \"B07S73F2SC\",\n \"B01C6KPPO2\",\n \"B07CBSBGXP\",\n \"B083DPCXN5\",\n \"B09WX9JD1D\",\n \"B09R43RZV9\",\n \"B07RLQ3YB9\",\n \"B07FPQ39TR\",\n \"B08LJC7VNW\",\n \"B07FCHKJDM\",\n \"B08NDST2P6\",\n \"B08DXLRMRC\",\n \"B09JVWD1D3\",\n \"B09NRXXC7P\",\n \"B0006I6V54\",\n \"B00JPVFCIU\",\n \"B08T59DSFQ\",\n \"B07DSG9QM9\",\n \"B0B2Q9YD22\",\n \"B00DD0CD9K\",\n \"B00CEOKYBU\",\n \"B00JHDGROE\",\n \"B08DDHN336\",\n \"B09TH3X71J\",\n \"B09WR21M2P\",\n \"B09T9P6D88\",\n \"B071LPZMN6\",\n \"B072P5WQ3M\",\n \"B09VPFJYVR\",\n \"B0B4BFTB3D\"\n ]\n },\n {\n \"theme\": \"Complements\",\n \"description\": \"Items frequently bought together as complements (e.g. tennis balls with tennis raquets)\",\n \"recommendedAsins\": [\n \"B091K1C3KD\",\n \"B09VPFJYVR\",\n \"B09TLM53P7\",\n \"B099QV15NM\",\n \"B0B4BFTB3D\",\n \"B09B4QD42W\"\n ]\n }\n ],\n \"nextCursor\": null,\n \"previousCursor\": null\n}" } ] }, { "name": "Category recommendations", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spproducttargeting.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"asins\": [\n \"B00JVTNXIC\"\n ],\n \"includeAncestor\": true\n}" }, "url": "{{api_url}}/sp/targets/categories/recommendations" }, "response": [ { "name": "Categories for one ASIN", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spproducttargeting.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"asins\": [\n \"B00JVTNXIC\"\n ],\n \"includeAncestor\": true\n}" }, "url": "{{api_url}}/sp/targets/categories/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 24 Aug 2022 13:48:25 GMT" }, { "key": "Content-Type", "value": "application/vnd.spproducttargetingresponse.v3+json" }, { "key": "Content-Length", "value": "810" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "Q08K76BZNEYBXGMPY71W" }, { "key": "x-amzn-RequestId", "value": "427ba011-0d19-45a4-9066-988ef504acd3" }, { "key": "x-amz-apigw-id", "value": "XXvWcEZVoAMFQXA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63062c29-872af3868894b57980cfb8d5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"categories\": [\n {\n \"id\": \"7147440011\",\n \"name\": \"Women's Fashion\",\n \"parent\": \"7141123011\",\n \"canBeTargeted\": true,\n \"path\": \"/Clothing, Shoes & Jewelry/Women's Fashion\"\n },\n {\n \"id\": \"7141123011\",\n \"name\": \"Clothing, Shoes & Jewelry\",\n \"parent\": \"-1\",\n \"canBeTargeted\": true,\n \"path\": \"/Clothing, Shoes & Jewelry\"\n },\n {\n \"id\": \"1044920\",\n \"name\": \"Women's Athletic Socks\",\n \"parent\": \"3456051\",\n \"canBeTargeted\": true,\n \"path\": \"/Clothing, Shoes & Jewelry/Women's Fashion/Women's Clothing/Women's Activewear/Women's Athletic Socks\"\n },\n {\n \"id\": \"3456051\",\n \"name\": \"Women's Activewear\",\n \"parent\": \"1040660\",\n \"canBeTargeted\": true,\n \"path\": \"/Clothing, Shoes & Jewelry/Women's Fashion/Women's Clothing/Women's Activewear\"\n },\n {\n \"id\": \"1040660\",\n \"name\": \"Women's Clothing\",\n \"parent\": \"7147440011\",\n \"canBeTargeted\": true,\n \"path\": \"/Clothing, Shoes & Jewelry/Women's Fashion/Women's Clothing\"\n }\n ]\n}" } ] } ] }, { "name": "Keywords", "item": [ { "name": "Create Keywords", "event": [ { "listen": "test", "script": { "exec": [ "if(responseCode.code === 207) {", " var result = JSON.parse(responseBody);", " var keywordId = result.keywords.success[0].keywordId;", " postman.clearEnvironmentVariable(\"keywordId\");", " pm.environment.set(\"keywordId\", keywordId); ", " console.log(\"keywordId is \" + keywordId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"EXACT\",\n \"state\": \"ENABLED\",\n \"bid\": 0.02,\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"soap bar\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords" }, "response": [ { "name": "Success with native language locale", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"EXACT\",\n \"state\": \"ENABLED\",\n \"bid\": 0.02,\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"soap bar\",\n \"nativeLanguageLocale\" : \"zh_CN\",\n \"nativeLanguageKeyword\" : \"肥皂\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 15 Sep 2022 18:43:52 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "319" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ATT7DV0MNMQT27Y7VPWZ" }, { "key": "x-amzn-RequestId", "value": "49330484-9522-4112-ae58-b71d66f25e63" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "6298b778-e99b-420a-a86d-57ddb1644bdc" }, { "key": "x-amzn-Remapped-Content-Length", "value": "319" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "Yg7QYHU4oAMF_6w=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63237268-be1eda3f039ab6478173dff0" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 15 Sep 2022 18:43:52 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"keyword\": {\n \"adGroupId\": \"80908659241419\",\n \"bid\": 0.02,\n \"campaignId\": \"152865535357884\",\n \"keywordId\": \"104465559608285\",\n \"keywordText\": \"soap bar\",\n \"matchType\": \"EXACT\",\n \"nativeLanguageKeyword\": \"肥皂\",\n \"nativeLanguageLocale\": \"zh_CN\",\n \"state\": \"ENABLED\"\n },\n \"keywordId\": \"104465559608285\"\n }\n ]\n }\n}" }, { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"EXACT\",\n \"state\": \"ENABLED\",\n \"bid\": 0.02,\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"soap bar\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 15 Sep 2022 18:44:17 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "255" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "Q7T2DCQ48WV1WC89NZ3M" }, { "key": "x-amzn-RequestId", "value": "6dc7b8e4-c843-4895-9938-ab2deaaceae8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "e1de7f0e-76ef-4f71-9e99-8b8ef745606b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "255" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "Yg7UOHYMIAMFvRw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63237281-2063ed3aab659a6063a6bdf4" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 15 Sep 2022 18:44:17 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"keyword\": {\n \"adGroupId\": \"80908659241419\",\n \"bid\": 0.02,\n \"campaignId\": \"152865535357884\",\n \"keywordId\": \"104465559608285\",\n \"keywordText\": \"soap bar\",\n \"matchType\": \"EXACT\",\n \"state\": \"ENABLED\"\n },\n \"keywordId\": \"104465559608285\"\n }\n ]\n }\n}" } ] }, { "name": "List keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n },\n \"includeExtendedDataFields\": true,\n \"locale\": \"es_MX\",\n \"keywordTextFilter\": {\n \"queryTermMatchType\": \"BROAD_MATCH\",\n \"include\": [\n \"soap\"\n ]\n },\n \"keywordIdFilter\": {\n \"include\": [\n \"{{keywordId}}\"\n ]\n },\n \"matchTypeFilter\": [\n \"EXACT\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n },\n \"includeExtendedDataFields\": true,\n \"locale\": \"es_MX\",\n \"keywordTextFilter\": {\n \"queryTermMatchType\": \"BROAD_MATCH\",\n \"include\": [\n \"soap\"\n ]\n },\n \"keywordIdFilter\": {\n \"include\": [\n \"{{keywordId}}\"\n ]\n },\n \"matchTypeFilter\": [\n \"EXACT\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:25:45 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "505" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "GFRKD1PENR4N7YDZT6VX" }, { "key": "x-amzn-RequestId", "value": "526a774d-6e39-4a30-8cc3-119acf3a01d7" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "9411ca4a-759a-4cda-b8c0-3327fc85178d" }, { "key": "x-amzn-Remapped-Content-Length", "value": "505" }, { "key": "x-amz-apigw-id", "value": "YhtVgGpwoAMF-_w=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c289-9bff0c7cdf6b7ff60f3d3ee9" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:25:45 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywords\": [\n {\n \"adGroupId\": \"220795965021387\",\n \"bid\": 0.02,\n \"campaignId\": \"102579222643121\",\n \"extendedData\": {\n \"creationDate\": 1663287636750,\n \"creationDateTime\": \"2022-09-16T00:20:36.750Z\",\n \"lastUpdateDate\": 1663287636750,\n \"lastUpdateDateTime\": \"2022-09-16T00:20:36.750Z\",\n \"servingStatus\": \"PENDING_START_DATE\",\n \"statusReasons\": [\n \"AD_GROUP_INCOMPLETE_DETAIL\",\n \"PENDING_START_DATE_DETAIL\",\n \"AD_GROUP_PAUSED_DETAIL\"\n ]\n },\n \"keywordId\": \"88150926783794\",\n \"keywordText\": \"soap bar\",\n \"matchType\": \"EXACT\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalResults\": 1\n}" } ] }, { "name": "Update keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n {\n \"keywordId\": \"{{keywordId}}\",\n \"state\": \"ENABLED\",\n \"bid\": 0.05\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords" }, "response": [ { "name": "Update bid", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n {\n \"keywordId\": \"{{keywordId}}\",\n \"state\": \"ENABLED\",\n \"bid\": 0.05\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:17:56 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "255" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QNNEPN5Z9ZA7KQZTA2TP" }, { "key": "x-amzn-RequestId", "value": "4c59bbdc-2578-402d-bf7f-8994370c0079" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "72a1292f-5226-4552-9f01-4523a267d1a5" }, { "key": "x-amzn-Remapped-Content-Length", "value": "255" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "YhsMLE1zIAMFn3Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c0b4-c902843b1f705ee59ee308e0" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:17:56 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"keyword\": {\n \"adGroupId\": \"220795965021387\",\n \"bid\": 0.05,\n \"campaignId\": \"102579222643121\",\n \"keywordId\": \"276830701500394\",\n \"keywordText\": \"toy car\",\n \"matchType\": \"EXACT\",\n \"state\": \"ENABLED\"\n },\n \"keywordId\": \"276830701500394\"\n }\n ]\n }\n}" } ] }, { "name": "Delete keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywordIdFilter\": {\n \"include\": [\n \"{{keywordId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"keywordIdFilter\": {\n \"include\": [\n \"{{keywordId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/keywords/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:19:06 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "79" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QCN0ERFBTXGMY509BW0E" }, { "key": "x-amzn-RequestId", "value": "c1b74474-874c-45d8-a53f-9b1aa8baac1d" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "ca1f0034-7b3c-4333-ae6a-4a0b102e4753" }, { "key": "x-amzn-Remapped-Content-Length", "value": "79" }, { "key": "x-amz-apigw-id", "value": "YhsXDH7RIAMFzLA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c0fa-c8ad792502bb9d293cacb1aa" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:19:06 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"keywordId\": \"276830701500394\"\n }\n ]\n }\n}" } ] }, { "name": "Keyword Recommendation for existing adGroup", "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spkeywordsrecommendation.v5+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"recommendationType\": \"KEYWORDS_FOR_ASINS\",\n \"sortDimension\": \"CLICKS\",\n \"maxRecommendations\": \"2\",\n \"locale\" : \"es_MX\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/targets/keywords/recommendations" }, "response": [ { "name": "Success for ad group", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spkeywordsrecommendation.v5+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"recommendationType\": \"KEYWORDS_FOR_ADGROUP\",\n \"campaignId\": {{campaignId}},\n \"adGroupId\" : {{adGroupId}},\n \"sortDimension\": \"CLICKS\",\n \"maxRecommendations\": \"2\",\n \"locale\" : \"es_MX\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/targets/keywords/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 08 Sep 2022 21:02:12 GMT" }, { "key": "Content-Type", "value": "application/vnd.spkeywordsrecommendation.v5+json" }, { "key": "Content-Length", "value": "1357" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "FW393BN77XYT2Q233BG8" }, { "key": "x-amzn-RequestId", "value": "a3e9ae63-53ed-485c-9482-50cf4ab97c80" }, { "key": "x-amz-apigw-id", "value": "YKK9IHKooAMFu9Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-631a5854-b6fd1f89091c8285a3a1c11b" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywordTargetList\": [\n {\n \"keyword\": \"foaming hand soap refill\",\n \"bidInfo\": [\n {\n \"matchType\": \"PHRASE\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 1,\n \"bid\": 311,\n \"suggestedBid\": {\n \"rangeStart\": 126,\n \"rangeMedian\": 311,\n \"rangeEnd\": 476\n }\n },\n {\n \"matchType\": \"EXACT\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 1,\n \"bid\": 256,\n \"suggestedBid\": {\n \"rangeStart\": 125,\n \"rangeMedian\": 256,\n \"rangeEnd\": 455\n }\n },\n {\n \"matchType\": \"BROAD\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 1,\n \"bid\": 316,\n \"suggestedBid\": {\n \"rangeStart\": 128,\n \"rangeMedian\": 316,\n \"rangeEnd\": 483\n }\n }\n ],\n \"translation\": \"recarga de jabón de manos espumoso\",\n \"userSelectedKeyword\": false,\n \"searchTermImpressionRank\": null,\n \"searchTermImpressionShare\": null,\n \"recId\": \"b3c46375-1534-49bb-a25f-99f4199cc97f\"\n },\n {\n \"keyword\": \"foaming soap\",\n \"bidInfo\": [\n {\n \"matchType\": \"PHRASE\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 2,\n \"bid\": 456,\n \"suggestedBid\": {\n \"rangeStart\": 117,\n \"rangeMedian\": 456,\n \"rangeEnd\": 830\n }\n },\n {\n \"matchType\": \"BROAD\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 2,\n \"bid\": 205,\n \"suggestedBid\": {\n \"rangeStart\": 153,\n \"rangeMedian\": 205,\n \"rangeEnd\": 336\n }\n },\n {\n \"matchType\": \"EXACT\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 2,\n \"bid\": 143,\n \"suggestedBid\": {\n \"rangeStart\": 85,\n \"rangeMedian\": 143,\n \"rangeEnd\": 152\n }\n }\n ],\n \"translation\": \"jabón espumoso\",\n \"userSelectedKeyword\": false,\n \"searchTermImpressionRank\": null,\n \"searchTermImpressionShare\": null,\n \"recId\": \"d8c36993-df47-4b26-a8f0-a9c166ebc878\"\n }\n ],\n \"impactMetrics\": null\n}" }, { "name": "Success for ASINS", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spkeywordsrecommendation.v5+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"recommendationType\": \"KEYWORDS_FOR_ASINS\",\n \"sortDimension\": \"DEFAULT\",\n \"maxRecommendations\": \"2\",\n \"locale\" : \"es_MX\",\n \"asins\" : [\n \"B09VFD8479\",\n \"B074XXSSD5\"\n ],\n \"biddingStrategy\": \"LEGACY_FOR_SALES\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/targets/keywords/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 08 Sep 2022 21:31:03 GMT" }, { "key": "Content-Type", "value": "application/vnd.spkeywordsrecommendation.v5+json" }, { "key": "Content-Length", "value": "1390" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ZF4E87R7228GY739VT8Y" }, { "key": "x-amzn-RequestId", "value": "963bb18e-8ef8-4321-92bf-434f0c2f1d0a" }, { "key": "x-amz-apigw-id", "value": "YKPLoHdtIAMFqXw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-631a5f17-87fc4801b2adc958b0c24dbf" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"keywordTargetList\": [\n {\n \"keyword\": \"foaming hand soap refill\",\n \"bidInfo\": [\n {\n \"matchType\": \"EXACT\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 1,\n \"bid\": 179,\n \"suggestedBid\": {\n \"rangeStart\": 141,\n \"rangeMedian\": 179,\n \"rangeEnd\": 282\n }\n },\n {\n \"matchType\": \"BROAD\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 1,\n \"bid\": 177,\n \"suggestedBid\": {\n \"rangeStart\": 112,\n \"rangeMedian\": 177,\n \"rangeEnd\": 297\n }\n },\n {\n \"matchType\": \"PHRASE\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 1,\n \"bid\": 164,\n \"suggestedBid\": {\n \"rangeStart\": 104,\n \"rangeMedian\": 164,\n \"rangeEnd\": 268\n }\n }\n ],\n \"translation\": \"recarga de jabón de manos espumoso\",\n \"userSelectedKeyword\": false,\n \"searchTermImpressionRank\": null,\n \"searchTermImpressionShare\": null,\n \"recId\": \"99ab9fa8-75c9-44ab-bf2c-e4e25277a170\"\n },\n {\n \"keyword\": \"liquid soap hand refill\",\n \"bidInfo\": [\n {\n \"matchType\": \"BROAD\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 2,\n \"bid\": 187,\n \"suggestedBid\": {\n \"rangeStart\": 161,\n \"rangeMedian\": 187,\n \"rangeEnd\": 313\n }\n },\n {\n \"matchType\": \"PHRASE\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 2,\n \"bid\": 198,\n \"suggestedBid\": {\n \"rangeStart\": 163,\n \"rangeMedian\": 198,\n \"rangeEnd\": 317\n }\n },\n {\n \"matchType\": \"EXACT\",\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"rank\": 2,\n \"bid\": 211,\n \"suggestedBid\": {\n \"rangeStart\": 167,\n \"rangeMedian\": 211,\n \"rangeEnd\": 316\n }\n }\n ],\n \"translation\": \"Recambio de manos de jabón líquido\",\n \"userSelectedKeyword\": false,\n \"searchTermImpressionRank\": null,\n \"searchTermImpressionShare\": null,\n \"recId\": \"9635b11f-0d57-41ca-b7c0-43871b8bdf22\"\n }\n ],\n \"impactMetrics\": null\n}" } ] } ] }, { "name": "Theme-based bid recommendations", "item": [ { "name": "Get recommendations", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spthemebasedbidrecommendation.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"recommendationType\": \"BIDS_FOR_EXISTING_AD_GROUP\",\n \"targetingExpressions\": [\n {\n \"type\": \"KEYWORD_BROAD_MATCH\",\n \"value\": \"av cable\"\n }\n ],\n \"campaignId\": \"{{campaignId}}\",\n \"adGroupId\": \"{{adGroupId}}\"\n}" }, "url": "{{api_url}}/sp/targets/bid/recommendations" }, "response": [ { "name": "Auto targets - existing ad group", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"recommendationType\": \"BIDS_FOR_EXISTING_AD_GROUP\",\n \"targetingExpressions\": [\n {\n \"type\": \"CLOSE_MATCH\"\n },\n {\n \"type\": \"COMPLEMENTS\"\n },\n {\n \"type\": \"LOOSE_MATCH\"\n },\n {\n \"type\": \"SUBSTITUTES\"\n }\n ],\n \"campaignId\": \"{{campaignId}}\",\n \"adGroupId\": \"{{adGroupId}}\"\n}" }, "url": "{{api_url}}/sp/targets/bid/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 24 Aug 2022 02:45:28 GMT" }, { "key": "Content-Type", "value": "application/json;charset=utf-8" }, { "key": "Content-Length", "value": "867" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "9AXZW2XV95P61YTDRRK4" }, { "key": "x-amzn-RequestId", "value": "c3849b17-5b41-4103-aec4-ed945f0db297" }, { "key": "x-amzn-Remapped-Content-Length", "value": "867" }, { "key": "x-amzn-Remapped-Connection", "value": "keep-alive" }, { "key": "x-amz-apigw-id", "value": "XWOPPEBloAMFmyw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-630590c8-21c9f4095140164da01c5d83" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 24 Aug 2022 02:45:28 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" }, { "key": "Permissions-Policy", "value": "interest-cohort=()" } ], "cookie": [], "body": "{\n \"bidRecommendations\": [\n {\n \"theme\": \"CONVERSION_OPPORTUNITIES\",\n \"impactMetrics\": {\n \"clicks\": {\n \"values\": [\n {\n \"lower\": 24,\n \"upper\": 32\n },\n {\n \"lower\": 48,\n \"upper\": 64\n },\n {\n \"lower\": 71,\n \"upper\": 96\n }\n ]\n },\n \"orders\": {\n \"values\": [\n {\n \"lower\": 3,\n \"upper\": 4\n },\n {\n \"lower\": 5,\n \"upper\": 7\n },\n {\n \"lower\": 8,\n \"upper\": 10\n }\n ]\n }\n },\n \"bidRecommendationsForTargetingExpressions\": [\n {\n \"targetingExpression\": {\n \"type\": \"CLOSE_MATCH\",\n \"value\": null\n },\n \"bidValues\": [\n {\n \"suggestedBid\": 0.77\n },\n {\n \"suggestedBid\": 1\n },\n {\n \"suggestedBid\": 1.28\n }\n ]\n },\n {\n \"targetingExpression\": {\n \"type\": \"COMPLEMENTS\",\n \"value\": null\n },\n \"bidValues\": [\n {\n \"suggestedBid\": 1.01\n },\n {\n \"suggestedBid\": 1.11\n },\n {\n \"suggestedBid\": 1.25\n }\n ]\n },\n {\n \"targetingExpression\": {\n \"type\": \"LOOSE_MATCH\",\n \"value\": null\n },\n \"bidValues\": [\n {\n \"suggestedBid\": 0.12\n },\n {\n \"suggestedBid\": 0.13\n },\n {\n \"suggestedBid\": 0.16\n }\n ]\n },\n {\n \"targetingExpression\": {\n \"type\": \"SUBSTITUTES\",\n \"value\": null\n },\n \"bidValues\": [\n {\n \"suggestedBid\": 0.64\n },\n {\n \"suggestedBid\": 1.01\n },\n {\n \"suggestedBid\": 1.36\n }\n ]\n }\n ]\n }\n ]\n}" } ] } ] }, { "name": "Negative keywords", "item": [ { "name": "Create negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "if(responseCode.code === 207) {", " var result = JSON.parse(responseBody);", " var negativeKeywordId = result.negativeKeywords.success[0].negativeKeywordId;", " postman.clearEnvironmentVariable(\"negativeKeywordId\");", " pm.environment.set(\"negativeKeywordId\", negativeKeywordId); ", " console.log(\"negativeKeywordId is \" + negativeKeywordId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"fake\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"Toys\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:28:47 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "92" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "BJAC999BZBXA2PF0RYDT" }, { "key": "x-amzn-RequestId", "value": "d2c964c1-b767-4ab8-b9cc-7975ed10f73a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "4d6f1ed1-4d9e-44bd-8e8f-a6f794c94d71" }, { "key": "x-amzn-Remapped-Content-Length", "value": "92" }, { "key": "x-amz-apigw-id", "value": "Yhtx6E8NIAMFgJA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c33f-d8e80d0b5734f5f597e5fb61" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:28:47 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeKeywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeKeywordId\": \"124141728948\"\n }\n ]\n }\n}" } ] }, { "name": "Update negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywords\": [\n {\n \"keywordId\": \"{{negativeKeywordId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywords\": [\n {\n \"keywordId\": \"{{negativeKeywordId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:36:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "94" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "16J276D48MN25ZXEVZJ4" }, { "key": "x-amzn-RequestId", "value": "18ed5ab8-3007-434e-9c6e-f19255f0bd5d" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "8f5e728e-f3d7-415e-aff7-43aad1130689" }, { "key": "x-amzn-Remapped-Content-Length", "value": "94" }, { "key": "x-amz-apigw-id", "value": "Yhu-zFFEIAMFYJA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c52b-bd9946a85f46a75600e00479" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:36:58 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeKeywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeKeywordId\": \"92842624367646\"\n }\n ]\n }\n}" } ] }, { "name": "Delete negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywordIdFilter\": {\n \"include\": [\n \"{{negativeKeywordId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywordIdFilter\": {\n \"include\": [\n \"{{negativeKeywordId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:35:13 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "92" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "4TR74MGYA9MB4F4YK1JS" }, { "key": "x-amzn-RequestId", "value": "e404e4e4-e60e-4c84-a92d-139b98930a37" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3ee5c923-2cdf-4011-b695-ab861c8c4844" }, { "key": "x-amzn-Remapped-Content-Length", "value": "92" }, { "key": "x-amz-apigw-id", "value": "YhuuOH4-oAMFsAQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c4c1-106707e4a87950e4e7231282" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:35:12 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeKeywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeKeywordId\": \"124141728948\"\n }\n ]\n }\n}" } ] }, { "name": "List negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "/* Save negativeKeywordId of first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No negative keywords were returned\");", "} else {", "if(responseCode.code === 200) {", "var negativeKeywordId = response.targetingClauses[0].negativeKeywordId", "postman.clearEnvironmentVariable(\"negativeKeywordId\");", "postman.setEnvironmentVariable(\"negativeKeywordId\", negativeKeywordId);", " console.info(\"negativeKeywordId from first negative keyword object is \" + negativeKeywordId);", "} else {", " console.warn(responseBody);", "}", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 19:50:24 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "196" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1XAY3R1Z6N660Z1PR95A" }, { "key": "x-amzn-RequestId", "value": "e56ab5dd-c8c0-4b64-86c0-0f0ab854e045" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "335440e1-8469-4c41-aa74-20795ac69657" }, { "key": "x-amzn-Remapped-Content-Length", "value": "196" }, { "key": "x-amz-apigw-id", "value": "aXuwIEVCIAMF7Gw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352f800-004107fec44b859a1a6a9ba7" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 19:50:24 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeKeywords\": [\n {\n \"adGroupId\": \"121849963038619\",\n \"campaignId\": \"26256301417055\",\n \"keywordId\": \"5092276756639\",\n \"keywordText\": \"Toys\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"PAUSED\"\n }\n ],\n \"totalResults\": 1\n}" } ] } ] }, { "name": "Campaign negative keywords", "item": [ { "name": "Create campaign negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "if(responseCode.code === 207) {", " var result = JSON.parse(responseBody);", " var campaignNegativeKeywordId = result.campaignNegativeKeywords.success[0].campaignNegativeKeywordId;", " postman.clearEnvironmentVariable(\"campaignNegativeKeywordId\");", " pm.environment.set(\"campaignNegativeKeywordId\", campaignNegativeKeywordId); ", " console.log(\"campaignNegativeKeywordId is \" + campaignNegativeKeywordId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeKeywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"Toys\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeKeywords\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"keywordText\": \"Toys\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 19:54:06 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "111" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "J75BZ471AH1KGBB9CNW3" }, { "key": "x-amzn-RequestId", "value": "a28e1437-05f4-4f77-9051-1c0dd65038a8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "55985523-4191-4e2d-8a5d-0c7da0bfdd52" }, { "key": "x-amzn-Remapped-Content-Length", "value": "111" }, { "key": "x-amz-apigw-id", "value": "aXvSzGp4oAMFnNg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352f8de-c123e06349cda6ead79f13ed" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 19:54:06 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"campaignNegativeKeywords\": {\n \"error\": [],\n \"success\": [\n {\n \"campaignNegativeKeywordId\": \"175459097454834\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Update campaign negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeKeywords\": [\n {\n \"keywordId\": \"{{campaignNegativeKeywordId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords" }, "response": [ { "name": "Pause keyword", "originalRequest": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeKeywords\": [\n {\n \"keywordId\": \"{{negativeKeywordId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/negativeKeywords" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 16 Sep 2022 00:36:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "94" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "16J276D48MN25ZXEVZJ4" }, { "key": "x-amzn-RequestId", "value": "18ed5ab8-3007-434e-9c6e-f19255f0bd5d" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "8f5e728e-f3d7-415e-aff7-43aad1130689" }, { "key": "x-amzn-Remapped-Content-Length", "value": "94" }, { "key": "x-amz-apigw-id", "value": "Yhu-zFFEIAMFYJA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6323c52b-bd9946a85f46a75600e00479" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 16 Sep 2022 00:36:58 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeKeywords\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeKeywordId\": \"92842624367646\"\n }\n ]\n }\n}" } ] }, { "name": "Delete campaign negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeKeywordIdFilter\": {\n \"include\": [\n \"{{campaignNegativeKeywordId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeKeywordIdFilter\": {\n \"include\": [\n \"{{campaignNegativeKeywordId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 19:56:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "111" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "4DP8XKHSTDCQDP1Y4QAR" }, { "key": "x-amzn-RequestId", "value": "2580ac02-c920-4996-a23b-cdaa34e7dca9" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "d142f326-2bbd-4e33-b2bb-36e19067febf" }, { "key": "x-amzn-Remapped-Content-Length", "value": "111" }, { "key": "x-amz-apigw-id", "value": "aXvrLFaDoAMFmqA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352f97a-e6d9a0bdaea23fc55cc8acad" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 19:56:42 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"campaignNegativeKeywords\": {\n \"error\": [],\n \"success\": [\n {\n \"campaignNegativeKeywordId\": \"175459097454834\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "List campaign negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "/* Save keywordId of first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No campaign negative keywords were returned\");", "} else {", "if(responseCode.code === 200) {", "var keywordId = response.campaignNegativeKeywords[0].keywordId;", "postman.clearEnvironmentVariable(\"keywordId\");", "postman.setEnvironmentVariable(\"keywordId\", keywordId);", " console.info(\"keywordId from first campaign negative keyword object is \" + keywordId);", "} else {", " console.warn(responseBody);", "}", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeKeyword.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeKeywords/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 19:55:44 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "441" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QDTNWQEANJHGA5VT9Y90" }, { "key": "x-amzn-RequestId", "value": "622f9297-b1a7-44c8-a8fd-d1547d60fad8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "0a3a83b6-4e61-473c-abfc-50a634e73ccf" }, { "key": "x-amzn-Remapped-Content-Length", "value": "441" }, { "key": "x-amz-apigw-id", "value": "aXviBEbhoAMFegQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352f940-398336e6492be8b211ea8451" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 19:55:44 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"campaignNegativeKeywords\": [\n {\n \"campaignId\": \"26256301417055\",\n \"keywordId\": \"121429939592701\",\n \"keywordText\": \"helloworld\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"ENABLED\"\n },\n {\n \"campaignId\": \"26256301417055\",\n \"keywordId\": \"175459097454834\",\n \"keywordText\": \"Toys\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"PAUSED\"\n },\n {\n \"campaignId\": \"26256301417055\",\n \"keywordId\": \"255139551471314\",\n \"keywordText\": \"Toy\",\n \"matchType\": \"NEGATIVE_EXACT\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalResults\": 3\n}" } ] } ] }, { "name": "Negative targets", "item": [ { "name": "Create negative targets", "event": [ { "listen": "test", "script": { "exec": [ "/* Save targetId of first object to environment*/", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var targetId = response.negativeTargetingClauses.success[0].targetId;", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);", " console.log(\"targetId is \" + targetId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetingClauses\": [\n {\n \"expression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"18681839011\"\n }\n ],\n \"campaignId\": \"{{campaignId}}\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/negativeTargets" }, "response": [ { "name": "Single product", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetingClauses\": [\n {\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"campaignId\": \"26256301417055\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"169462822148652\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/negativeTargets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 07 Sep 2022 20:42:46 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "358" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "A0G1C8Q1P94VJHR408CN" }, { "key": "x-amzn-RequestId", "value": "83ab2313-318e-472d-b81f-03994602fa5c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "16277a5d-852a-488c-adf6-988b344ee623" }, { "key": "x-amzn-Remapped-Content-Length", "value": "358" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "YG1K_HgHIAMFxlg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63190246-7f9909b6947c92b13ef491b3" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 07 Sep 2022 20:42:46 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" } ], "cookie": [], "body": "{\n \"negativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeTargetingClause\": {\n \"adGroupId\": \"169462822148652\",\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"146760731000473\"\n },\n \"targetId\": \"146760731000473\"\n }\n ]\n }\n}" }, { "name": "Brand", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetingClauses\": [\n {\n \"expression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"18681839011\"\n }\n ],\n \"campaignId\": \"26256301417055\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"169462822148652\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/negativeTargets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 07 Sep 2022 20:47:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "366" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "XQZ50J69P47CC6JJPR7Q" }, { "key": "x-amzn-RequestId", "value": "699ffcb6-2c3a-48bf-ac78-589270833253" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "e9f2ae6c-cd78-4ee4-adbb-80d85257e36d" }, { "key": "x-amzn-Remapped-Content-Length", "value": "366" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "YG15IHZjIAMFXUg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6319036d-0783f9a2b8c68e51ee00266a" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 07 Sep 2022 20:47:41 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,X-Amzn-CDN-Cache,X-Amzn-AX-Treatment,User-Agent" } ], "cookie": [], "body": "{\n \"negativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeTargetingClause\": {\n \"adGroupId\": \"169462822148652\",\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"18681839011\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"DJECO\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"130105859086533\"\n },\n \"targetId\": \"130105859086533\"\n }\n ]\n }\n}" } ] }, { "name": "List negative targets", "event": [ { "listen": "test", "script": { "exec": [ "/* Save keywordId of first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No campaign negative keywords were returned\");", "} else {", "if(responseCode.code === 200) {", "var negativeTargetId = response.negativeTargetingClauses[0].targetId", "postman.clearEnvironmentVariable(\"negativeTargetId\");", "postman.setEnvironmentVariable(\"negativeTargetId\", negativeTargetId);", " console.info(\"targetId from first negative targeting clause object is \" + negativeTargetId);", "} else {", " console.warn(responseBody);", "}", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": "{{api_url}}/sp/negativeTargets/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": "{{api_url}}/sp/negativeTargets/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 19:58:44 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "775" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JQX0V2V8RZ2ZAZ2DMVH4" }, { "key": "x-amzn-RequestId", "value": "330c4390-0372-4ac9-bd65-07679f295da7" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "bef6c835-7f3c-4849-b1b5-7d1fd5db3984" }, { "key": "x-amzn-Remapped-Content-Length", "value": "775" }, { "key": "x-amz-apigw-id", "value": "aXv-PGsAIAMFfUw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352f9f4-ef7872189ee1ebe9c95133ae" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 19:58:44 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeTargetingClauses\": [\n {\n \"adGroupId\": \"169462822148652\",\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"18681839011\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"DJECO\"\n }\n ],\n \"state\": \"ARCHIVED\",\n \"targetId\": \"130105859086533\"\n },\n {\n \"adGroupId\": \"169462822148652\",\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"146760731000473\"\n },\n {\n \"adGroupId\": \"89316565505073\",\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"18681839011\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_BRAND_SAME_AS\",\n \"value\": \"DJECO\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"152070675333811\"\n }\n ],\n \"totalResults\": 3\n}" } ] }, { "name": "Update negative targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetingClauses\": [\n {\n \"targetId\": \"{{targetId}}\",\n \"state\": \"ENABLED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/negativeTargets" }, "response": [ { "name": "Update status", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetingClauses\": [\n {\n \"targetId\": \"146760731000473\",\n \"state\": \"ENABLED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/negativeTargets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 20:07:21 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "358" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ZFXK8KRP7670AMEQ7VVA" }, { "key": "x-amzn-RequestId", "value": "3a7e6916-5886-4527-a14b-ff317519a780" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "d5b2220f-8e31-4641-a979-30e8e947b190" }, { "key": "x-amzn-Remapped-Content-Length", "value": "358" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "aXxO5F9QIAMFfiQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352fbf8-f92d1aa9e856fe4edf676467" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 20:07:21 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"negativeTargetingClause\": {\n \"adGroupId\": \"169462822148652\",\n \"campaignId\": \"26256301417055\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"146760731000473\"\n },\n \"targetId\": \"146760731000473\"\n }\n ]\n }\n}" } ] }, { "name": "Delete negative targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetIdFilter\": {\n \"include\": [\n \"{{targetId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/negativeTargets/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargetIdFilter\": {\n \"include\": [\n \"146760731000473\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/negativeTargets/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 20:08:00 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "95" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "0YWJHZ08SJCFJ1EPM36Z" }, { "key": "x-amzn-RequestId", "value": "2863a105-4bba-47b5-b8ab-381acc677095" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "f13d71e0-d440-4d40-a685-56493eac8ffd" }, { "key": "x-amzn-Remapped-Content-Length", "value": "95" }, { "key": "x-amz-apigw-id", "value": "aXxVIEDDoAMFVTg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352fc20-d3df5a1bec415b8ebf9ce0f3" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 20:08:00 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"negativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"index\": 0,\n \"targetId\": \"146760731000473\"\n }\n ]\n }\n}" } ] } ] }, { "name": "Campaign negative targets", "item": [ { "name": "Create campaign negative targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/* Save targetId of first object to environment*/", "var response = JSON.parse(responseBody);", "var targetId = response.negativeTargetingClauses[0].targetId", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeTargetingClauses\": [\n {\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07R7V6KS8\"\n }\n ],\n \"campaignId\": \"26256301417055\",\n \"state\": \"ENABLED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeTargets" }, "response": [ { "name": "Single product", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeTargetingClauses\": [\n {\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07R7V6KS8\"\n }\n ],\n \"campaignId\": \"276748589410145\",\n \"state\": \"ENABLED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaignNegativeTargets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 01 Nov 2022 15:00:11 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "371" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "H9AF5D4A4GQ8D2X96ZD6" }, { "key": "x-amzn-RequestId", "value": "d3390d99-2b5a-4415-bca8-3cf5061e095e" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "489db9ee-e15c-4633-8c72-7ed86487ba9e" }, { "key": "x-amzn-Remapped-Content-Length", "value": "371" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "a7UjTEIUoAMF3Cg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6361347b-67bb6e86df7f2de4051bdad2" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 01 Nov 2022 15:00:11 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaignNegativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"campaignNegativeTargetingClauseId\": \"255998161627132\",\n \"campaignNegativeTargetingClauses\": {\n \"campaignId\": \"276748589410145\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07R7V6KS8\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07R7V6KS8\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"255998161627132\"\n },\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "List campaign negative target", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/* Save targetId of first object to environment*/", "var response = JSON.parse(responseBody);", "var targetId = response.campaignNegativeTargetingClauses[0].targetId", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "url": "{{api_url}}/sp/campaignNegativeTargets/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "url": "{{api_url}}/sp/campaignNegativeTargets/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 01 Nov 2022 14:59:45 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "470" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "900SBF45KHRVFW6RVYST" }, { "key": "x-amzn-RequestId", "value": "132b2836-3999-4a42-9b4d-15b44e01f5f2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "66051ea0-2f6e-4b65-89dc-e07139b34f1c" }, { "key": "x-amzn-Remapped-Content-Length", "value": "470" }, { "key": "x-amz-apigw-id", "value": "a7UfRHoPIAMFcfw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63613461-409c968acbf2369cced8e81d" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 01 Nov 2022 14:59:45 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaignNegativeTargetingClauses\": [\n {\n \"campaignId\": \"276748589410145\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B00HVWSQG0\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B00HVWSQG0\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"91183015695412\"\n },\n {\n \"campaignId\": \"276748589410145\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07R7V6KS8\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B07R7V6KS8\"\n }\n ],\n \"state\": \"ENABLED\",\n \"targetId\": \"31200360671512\"\n }\n ],\n \"totalResults\": 2\n}" } ] }, { "name": "Update campaign negative targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeTargetingClauses\": [\n {\n \"targetId\": \"{{targetId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/campaignNegativeTargets" }, "response": [ { "name": "Update status", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeTargetingClauses\": [\n {\n \"targetId\": \"{{targetId}}\",\n \"state\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/campaignNegativeTargets" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 01 Nov 2022 15:08:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "368" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "03B1XMY9Q39DB712XRTD" }, { "key": "x-amzn-RequestId", "value": "e5861095-3b81-4c44-ba19-1d74e55b01f2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "5ba3ac9d-74ad-484d-8512-025eb4e2a4c1" }, { "key": "x-amzn-Remapped-Content-Length", "value": "368" }, { "key": "Preference-Applied", "value": "return=representation" }, { "key": "x-amz-apigw-id", "value": "a7V1zFICoAMFnSQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6361368b-205feb13257f2db9c1421f4e" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 01 Nov 2022 15:08:59 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaignNegativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"campaignNegativeTargetingClauseId\": \"91183015695412\",\n \"campaignNegativeTargetingClauses\": {\n \"campaignId\": \"276748589410145\",\n \"expression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B00HVWSQG0\"\n }\n ],\n \"resolvedExpression\": [\n {\n \"type\": \"ASIN_SAME_AS\",\n \"value\": \"B00HVWSQG0\"\n }\n ],\n \"state\": \"PAUSED\",\n \"targetId\": \"91183015695412\"\n },\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Delete campaign negative targets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeTargetIdFilter\": {\n \"include\": [\n \"{{targetId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/campaignNegativeTargets/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" }, { "key": "Accept", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.spCampaignNegativeTargetingClause.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignNegativeTargetIdFilter\": {\n \"include\": [\n \"{{targetId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sp/campaignNegativeTargets/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 01 Nov 2022 15:12:31 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "127" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "XKMRHFYA26HDKM8MJ7TF" }, { "key": "x-amzn-RequestId", "value": "bc74b3e7-9eed-4112-ab78-19024694011f" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "54d5e652-a1c0-4942-a399-2f91bbca9cef" }, { "key": "x-amzn-Remapped-Content-Length", "value": "127" }, { "key": "x-amz-apigw-id", "value": "a7WW-HenIAMFcwQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6361375f-de327b519f17e97f58ceac40" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 01 Nov 2022 15:12:31 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaignNegativeTargetingClauses\": {\n \"error\": [],\n \"success\": [\n {\n \"campaignNegativeTargetingClauseId\": \"91183015695412\",\n \"index\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Budget recommendations and missed opportunities", "item": [ { "name": "Get budget recommendations and missed opportunities", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.budgetrecommendation.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaigns/budgetRecommendations" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{259207489965973}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaigns/budgetRecommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 04 Oct 2022 18:12:01 GMT" }, { "key": "Content-Type", "value": "application/vnd.budgetrecommendation.v3+json" }, { "key": "Content-Length", "value": "479" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "C48F7W5SP4F1K4H91AB2" }, { "key": "x-amzn-RequestId", "value": "c815f303-eeac-4a42-822b-a699cb8eeb44" }, { "key": "x-amz-apigw-id", "value": "ZfeZyFDWoAMFQsg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633c7771-0f0eb8e8012d031bf1a78ede" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"budgetRecommendationsSuccessResults\": [\n {\n \"index\": 0,\n \"campaignId\": \"259207489965973\",\n \"suggestedBudget\": 13,\n \"sevenDaysMissedOpportunities\": {\n \"startDate\": \"20210609\",\n \"endDate\": \"20210615\",\n \"percentTimeInBudget\": 1,\n \"estimatedMissedImpressionsLower\": 0,\n \"estimatedMissedImpressionsUpper\": 0,\n \"estimatedMissedClicksLower\": 0,\n \"estimatedMissedClicksUpper\": 0,\n \"estimatedMissedSalesLower\": 0,\n \"estimatedMissedSalesUpper\": 0\n },\n \"budgetRuleRecommendation\": null\n }\n ],\n \"budgetRecommendationsErrorResults\": []\n}" }, { "name": "No data to give recommendations", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sp/campaigns/budgetRecommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 22:40:57 GMT" }, { "key": "Content-Type", "value": "application/vnd.budgetrecommendation.v3+json" }, { "key": "Content-Length", "value": "214" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "XV9PPSS2SA4EX387FA52" }, { "key": "x-amzn-RequestId", "value": "f8ce33b6-c847-4f77-a30b-9e2b51a4e0fd" }, { "key": "x-amz-apigw-id", "value": "ZjYvCG6ZoAMFa0Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633e07f9-bc2c89ea3b317b46afa86f54" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"budgetRecommendationsSuccessResults\": [\n {\n \"index\": 0,\n \"campaignId\": \"254916660662680\",\n \"suggestedBudget\": null,\n \"sevenDaysMissedOpportunities\": null,\n \"budgetRuleRecommendation\": null\n }\n ],\n \"budgetRecommendationsErrorResults\": []\n}" } ] } ] }, { "name": "Budget rules", "item": [ { "name": "Create budget rules", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/* Save ruleId to environment*/", "var response = JSON.parse(responseBody);", "var ruleId = response.responses[0].ruleId", "postman.clearEnvironmentVariable(\"ruleId\");", "postman.setEnvironmentVariable(\"ruleId\", ruleId);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20221201\",\n \"startDate\": \"20221102\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\",\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 10\n },\n \"name\": \"My budget rule\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "response": [ { "name": "Event-based daily rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"duration\": {\n \"eventTypeRuleDuration\": {\n \"eventId\": \"b7c1f022-e721-5635-8bce-8375ce163ebd\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\",\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 10\n },\n \"name\": \"My budget rule\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 13:58:03 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "138" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JZJYNJ4KTYK0VNAQ15DX" }, { "key": "x-amzn-RequestId", "value": "af11d539-7d4c-4e45-9d94-c5d3dbb0a81c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "JZJYNJ4KTYK0VNAQ15DX" }, { "key": "X-Amz-Date", "value": "Fri, 21 Oct 2022 13:58:03 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "138" }, { "key": "x-amz-apigw-id", "value": "aW7I2EQmIAMFo_A=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352a56b-d2a69b25a8a7af07919a134a" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 13:58:03 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"bd291382-c939-46a6-9149-52358167e170\"\n }\n ]\n}" }, { "name": "Performance-based weekly rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20221205\",\n \"startDate\": \"20221105\"\n }\n },\n \"recurrence\": {\n \"type\": \"WEEKLY\",\n \"daysOfWeek\": [\n \"MONDAY\",\"WEDNESDAY\",\"FRIDAY\"\n ]\n },\n \"ruleType\": \"PERFORMANCE\",\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"name\": \"My performance-based budget rule\",\n \"performanceMeasureCondition\": {\n \"metricName\": \"ACOS\",\n \"comparisonOperator\": \"GREATER_THAN\",\n \"threshold\": 5\n }\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 14:07:56 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "138" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "3DVBCH8A2JP8NNR39E7A" }, { "key": "x-amzn-RequestId", "value": "350bd7cd-221f-44e5-8fb7-8a8847ea91ae" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3DVBCH8A2JP8NNR39E7A" }, { "key": "X-Amz-Date", "value": "Fri, 21 Oct 2022 14:07:56 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "138" }, { "key": "x-amz-apigw-id", "value": "aW8lfEWKIAMFs0A=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352a7bc-9c386dd0f95220da2e21c16f" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 14:07:56 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"47270a9c-a1f6-4b2c-b326-1e18b7aa0002\"\n }\n ]\n}" } ] }, { "name": "Associate rule to campaign", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\"{{ruleId}}\"]\n}" }, "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\"{{ruleId}}\"]\n}" }, "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 14:14:58 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "112" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "X1F49881JV1CNQ8ADD66" }, { "key": "x-amzn-RequestId", "value": "54fccf2e-73e5-43f8-8034-b9c55407cbf5" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "X1F49881JV1CNQ8ADD66" }, { "key": "X-Amz-Date", "value": "Fri, 21 Oct 2022 14:14:58 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "112" }, { "key": "x-amz-apigw-id", "value": "aW9nTG-6IAMFTpQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352a962-b143a48ee2bedb304e5c2e7f" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 14:14:58 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"code\": \"Ok\",\n \"details\": \"Budget rule associated\",\n \"ruleId\": \"cc2df823-a202-4b37-8040-d214ee1d46b1\"\n }\n ]\n}" } ] }, { "name": "Get recommended events", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignId\": \"{{campaignId}}\"\n}" }, "url": "{{api_url}}/sp/campaigns/budgetRules/recommendations" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignId\": \"{{campaignId}}\"\n}" }, "url": "{{api_url}}/sp/campaigns/budgetRules/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 13:29:37 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "659" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "XB4RGYRYB4QGA9FQKPMT" }, { "key": "x-amzn-RequestId", "value": "dbb08d65-eab1-44dd-9bbc-98817bfa0c92" }, { "key": "x-amz-apigw-id", "value": "aW2-MEnuoAMFmlQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63529ec1-64c829d75afed83d196a6501" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"recommendedBudgetRuleEvents\": [\n {\n \"endDate\": \"20221101\",\n \"eventId\": \"b7c1f022-e721-5635-8bce-8375ce163ebd\",\n \"eventName\": \"Halloween\",\n \"startDate\": \"20221027\",\n \"suggestedBudgetIncreasePercent\": 98\n },\n {\n \"endDate\": \"20221128\",\n \"eventId\": \"f80f6499-f617-5a0f-b519-533850caabcd\",\n \"eventName\": \"Black Friday\",\n \"startDate\": \"20221118\",\n \"suggestedBudgetIncreasePercent\": 85\n },\n {\n \"endDate\": \"20221202\",\n \"eventId\": \"3d3790d7-dfc0-570f-8969-2f67bc300dd1\",\n \"eventName\": \"Cyber Monday\",\n \"startDate\": \"20221128\",\n \"suggestedBudgetIncreasePercent\": 86\n },\n {\n \"endDate\": \"20221222\",\n \"eventId\": \"fcebc6da-69de-5b9d-9a96-f238fb119225\",\n \"eventName\": \"Christmas\",\n \"startDate\": \"20221214\",\n \"suggestedBudgetIncreasePercent\": 60\n }\n ]\n}" } ] }, { "name": "Get budget rules", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/sp/budgetRules?pageSize=10", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules" ], "query": [ { "key": "pageSize", "value": "10" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/budgetRules?pageSize=10", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules" ], "query": [ { "key": "pageSize", "value": "10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 18 Oct 2022 20:50:24 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1662" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "RHWCT3NFP3FSYBNQ61V3" }, { "key": "x-amzn-RequestId", "value": "65db9d34-6c19-40dc-ba4a-8717cba618c8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "RHWCT3NFP3FSYBNQ61V3" }, { "key": "X-Amz-Date", "value": "Tue, 18 Oct 2022 20:50:24 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1662" }, { "key": "x-amz-apigw-id", "value": "aN-umGTmoAMFmxQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-634f1190-8d52cd9ef87781e75d9ecaac" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 18 Oct 2022 20:50:24 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"budgetRulesForAdvertiserResponse\": [\n {\n \"createdDate\": 1666125983543,\n \"lastUpdatedDate\": 1666125983543,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": null,\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 2\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"CTR\",\n \"threshold\": 1\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"fc8cd791-e1cd-4a23-934a-3214e11295c3\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n },\n {\n \"createdDate\": 1666125918468,\n \"lastUpdatedDate\": 1666125918468,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20221021\",\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 1\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"aaae82a7-6114-4825-8d37-574b98fbfd5a\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n },\n {\n \"createdDate\": 1666125878397,\n \"lastUpdatedDate\": 1666125878397,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": null,\n \"eventTypeRuleDuration\": {\n \"endDate\": \"20221101\",\n \"eventId\": \"b7c1f022-e721-5635-8bce-8375ce163ebd\",\n \"eventName\": \"Halloween\",\n \"startDate\": \"20221027\"\n }\n },\n \"name\": \"Halloween\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"1698dab1-e5ef-4716-8b45-f10e37765a03\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": null\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Get budget rules by campaign", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 21 Oct 2022 13:41:16 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "2291" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "HBBQBW9P30QNR7T350DN" }, { "key": "x-amzn-RequestId", "value": "922708b3-9204-4e28-937c-3898d20838c2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "HBBQBW9P30QNR7T350DN" }, { "key": "X-Amz-Date", "value": "Fri, 21 Oct 2022 13:41:16 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "2291" }, { "key": "x-amz-apigw-id", "value": "aW4rcGLBIAMFmYg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6352a17c-1891cb0a2f8426bda2d7597c" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 21 Oct 2022 13:41:16 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=300; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedRules\": [\n {\n \"createdDate\": 1666126775339,\n \"lastUpdatedDate\": 1666126775339,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 99\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": null,\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 3\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"5582d17b-cea1-468f-9694-faf2fa2705da\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": {\n \"reasonCode\": null,\n \"status\": \"ACTIVE\"\n }\n },\n {\n \"createdDate\": 1666125983543,\n \"lastUpdatedDate\": 1666125983543,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": null,\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 2\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"CTR\",\n \"threshold\": 1\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"fc8cd791-e1cd-4a23-934a-3214e11295c3\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ON_HOLD\",\n \"ruleStatusDetails\": {\n \"reasonCode\": \"INELIGIBLE_PERFORMANCE_METRIC\",\n \"status\": \"ON_HOLD\"\n }\n },\n {\n \"createdDate\": 1666125918468,\n \"lastUpdatedDate\": 1666125918468,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20221021\",\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 1\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"aaae82a7-6114-4825-8d37-574b98fbfd5a\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ON_HOLD\",\n \"ruleStatusDetails\": {\n \"reasonCode\": \"ELIGIBLE_SUPERSEDED\",\n \"status\": \"ON_HOLD\"\n }\n },\n {\n \"createdDate\": 1666125878397,\n \"lastUpdatedDate\": 1666125878397,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": null,\n \"eventTypeRuleDuration\": {\n \"endDate\": \"20221101\",\n \"eventId\": \"b7c1f022-e721-5635-8bce-8375ce163ebd\",\n \"eventName\": \"Halloween\",\n \"startDate\": \"20221027\"\n }\n },\n \"name\": \"Halloween\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"1698dab1-e5ef-4716-8b45-f10e37765a03\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": {\n \"reasonCode\": null,\n \"status\": \"PENDING_START\"\n }\n }\n ]\n}" } ] }, { "name": "Get budget history", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules/budgetHistory?pageSize=10&startDate=20221018&endDate=20221018", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules", "budgetHistory" ], "query": [ { "key": "pageSize", "value": "10" }, { "key": "startDate", "value": "20221018" }, { "key": "endDate", "value": "20221018" } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/campaigns/23391896962019/budgetRules/budgetHistory?pageSize=10&startDate=20221018&endDate=20221018", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", "23391896962019", "budgetRules", "budgetHistory" ], "query": [ { "key": "pageSize", "value": "10" }, { "key": "startDate", "value": "20221018" }, { "key": "endDate", "value": "20221018" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 18 Oct 2022 20:56:08 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1337" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CM9ATJ7JTDEHN6VM38KX" }, { "key": "x-amzn-RequestId", "value": "6fd236a4-3dce-4975-a2f6-8dac88cb2754" }, { "key": "x-amz-apigw-id", "value": "aN_joFSsIAMFd8g=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-634f12e8-ea5b4fdc90fb8d696465964e" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" } ], "cookie": [], "body": "{\n \"history\": [\n {\n \"PerformanceMetric\": null,\n \"appliedRule\": {\n \"createdDate\": null,\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20221021\",\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 1\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"aaae82a7-6114-4825-8d37-574b98fbfd5a\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n },\n \"dailyBudgetValue\": 100,\n \"executionTime\": 1666125984341,\n \"ruleBasedBudgetValue\": 198\n },\n {\n \"PerformanceMetric\": null,\n \"appliedRule\": {\n \"createdDate\": null,\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 98\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20221021\",\n \"startDate\": \"20221018\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Test 1\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"aaae82a7-6114-4825-8d37-574b98fbfd5a\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n },\n \"dailyBudgetValue\": 100,\n \"executionTime\": 1666125919212,\n \"ruleBasedBudgetValue\": 198\n },\n {\n \"PerformanceMetric\": null,\n \"appliedRule\": null,\n \"dailyBudgetValue\": 100,\n \"executionTime\": 1666125879082,\n \"ruleBasedBudgetValue\": null\n }\n ],\n \"nextToken\": null\n}" } ] } ] } ] }, { "name": "Sponsored Brands", "item": [ { "name": "Campaigns", "item": [ { "name": "Create campaigns", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save campaignId for first object to environment*/", "if (response.campaigns.success[0] != null ) {", "var campaignId = response.campaigns.success[0].campaignId;", "postman.clearEnvironmentVariable(\"campaignId\");", "postman.setEnvironmentVariable(\"campaignId\", campaignId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"budgetType\": \"DAILY\",\n \"name\": \"Name of campaign\",\n \"state\": \"ENABLED\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"budget\": 10,\n \"bidding\": {\n \"bidOptimization\": \"false\",\n \"bidAdjustmentsByShopperSegment\": [\n {\n \"percentage\": 200,\n \"shopperSegment\": \"NEW_TO_BRAND_PURCHASE\"\n }\n ],\n \"bidAdjustmentsByPlacement\": [\n {\n \"percentage\": 20,\n \"placement\": \"HOME\"\n },\n {\n \"percentage\": 15,\n \"placement\": \"DETAIL_PAGE\"\n },\n {\n \"percentage\": 15,\n \"placement\": \"OTHER\"\n }\n ],\n \"bidOptimizationStrategy\":\"MAXIMIZE_NEW_TO_BRAND_CUSTOMERS\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/campaigns", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Vendor", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"budgetType\": \"DAILY\",\n \"name\": \"Name of campaign\",\n \"state\": \"PAUSED\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2022-10-20\",\n \"budget\": 10\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:19:07 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "381" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "RAPA4PY9GPDHXGDST0K9" }, { "key": "x-amzn-RequestId", "value": "954ab2f6-4115-4924-a7d2-22940d8610c0" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "61f9f56f-5a9f-4dd1-8345-2b3b11edbf4f" }, { "key": "x-amzn-Remapped-Content-Length", "value": "381" }, { "key": "x-amz-apigw-id", "value": "ZiyXtE9rIAMFY8Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dca9a-8475838267e8a57345365026" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:19:06 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"budget\": 10,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"33598597792560\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Test v4 campaign 3\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2022-10-20\",\n \"state\": \"PAUSED\"\n },\n \"campaignId\": \"33598597792560\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Seller", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"budgetType\": \"DAILY\",\n \"name\": \"Name of campaign\",\n \"state\": \"PAUSED\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2022-10-20\",\n \"budget\": 10,\n \"brandEntityId\": \"{{brandEntityId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:24:01 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "421" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "WTV0QNATXKRG64MRN82J" }, { "key": "x-amzn-RequestId", "value": "6c555975-1c15-4b5e-8155-840844c98273" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "87caf347-ac62-495e-91ac-55bf65ce5842" }, { "key": "x-amzn-Remapped-Content-Length", "value": "421" }, { "key": "x-amz-apigw-id", "value": "ZizFtETToAMFSlw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dcbc1-1fe21f9445d0b750be60719e" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:24:01 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY1GY02L4M2U9FK\",\n \"budget\": 10,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"177829948461538\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Test v4 campaign 3\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2022-10-20\",\n \"state\": \"PAUSED\"\n },\n \"campaignId\": \"177829948461538\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Auto bidding success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"budgetType\": \"DAILY\",\n \"name\": \"Name of campaign\",\n \"state\": \"ENABLED\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"budget\": 10,\n \"bidding\": {\n \"bidOptimization\": \"true\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 28 Mar 2023 21:09:00 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "392" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "8XBQFDB6ECDBKDFXGT7R" }, { "key": "x-amzn-RequestId", "value": "e7a2b7c3-f473-4c3f-ba8a-df533547345d" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3ac0ff79-a09c-49e0-ba3e-b23318c042fa" }, { "key": "x-amzn-Remapped-Content-Length", "value": "392" }, { "key": "x-amz-apigw-id", "value": "CgqY_G0AoAMFZqA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6423576c-a8cb009940fe6e12e645e987" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 28 Mar 2023 21:09:00 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"budget\": 10,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"178005441007220\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Test campaign bidding auto\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"state\": \"ENABLED\"\n },\n \"campaignId\": \"178005441007220\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Manual bidding success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"budgetType\": \"DAILY\",\n \"name\": \"Name of campaign\",\n \"state\": \"ENABLED\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"budget\": 10,\n \"bidding\": {\n \"bidOptimization\": \"false\",\n \"bidAdjustmentsByShopperSegment\": [\n {\n \"percentage\": 200,\n \"shopperSegment\": \"NEW_TO_BRAND_PURCHASE\"\n }\n ],\n \"bidAdjustmentsByPlacement\": [\n {\n \"percentage\": 20,\n \"placement\": \"HOME\"\n },\n {\n \"percentage\": 15,\n \"placement\": \"DETAIL_PAGE\"\n },\n {\n \"percentage\": 15,\n \"placement\": \"OTHER\"\n }\n ],\n \"bidOptimizationStrategy\":\"MAXIMIZE_NEW_TO_BRAND_CUSTOMERS\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 28 Mar 2023 21:11:12 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "646" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "HR08RXRWYRA7SHMQQA6P" }, { "key": "x-amzn-RequestId", "value": "a9846f80-bba5-424d-9bd7-502b1c9ebdea" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "4e4101d4-5089-4644-bd4a-8826273c1e83" }, { "key": "x-amzn-Remapped-Content-Length", "value": "646" }, { "key": "x-amz-apigw-id", "value": "CgqtiEYZIAMFfoQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-642357f0-7006b9611a265f5262a0b43a" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 28 Mar 2023 21:11:11 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"bidding\": {\n \"bidAdjustmentsByPlacement\": [\n {\n \"percentage\": 15,\n \"placement\": \"DETAIL_PAGE\"\n },\n {\n \"percentage\": 15,\n \"placement\": \"OTHER\"\n },\n {\n \"percentage\": 20,\n \"placement\": \"HOME\"\n }\n ],\n \"bidAdjustmentsByShopperSegment\": [\n {\n \"percentage\": 200,\n \"shopperSegment\": \"NEW_TO_BRAND_PURCHASE\"\n }\n ],\n \"bidOptimization\": false,\n \"bidOptimizationStrategy\": \"MAXIMIZE_NEW_TO_BRAND_CUSTOMERS\"\n },\n \"budget\": 10,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"221517786174862\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Test campaign bidding manual\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"state\": \"ENABLED\"\n },\n \"campaignId\": \"221517786174862\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "List campaigns", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save campaignId for first object to environemnt*/", "var response = JSON.parse(responseBody);", "var campaignId = response.campaigns[0].campaignId", "postman.clearEnvironmentVariable(\"campaignId\");", "postman.setEnvironmentVariable(\"campaignId\", campaignId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "url": "{{api_url}}/sb/v4/campaigns/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "url": "{{api_url}}/sb/v4/campaigns/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Mar 2023 22:10:49 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "692" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7DZE3AP4MX2X68QBMR6A" }, { "key": "x-amzn-RequestId", "value": "1897d9e7-8465-4ec3-a69e-6fea175d9fe2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "6edf729d-4e01-460e-8b3c-92bcd2fd6cba" }, { "key": "x-amzn-Remapped-Content-Length", "value": "692" }, { "key": "x-amz-apigw-id", "value": "CJu4iEB7IAMF2OA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-641a2b69-4fe45dd3eb189be947fbeeab" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Mar 2023 22:10:48 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": [\n {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY21DWFJV45CH71\",\n \"budget\": 10,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"203755086457166\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Test v4 campaign store 2\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"state\": \"PAUSED\"\n },\n {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY21DWFJV45CH71\",\n \"budget\": 10,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"222860667662817\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Test v4 campaign\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-05-21\",\n \"state\": \"PAUSED\"\n }\n ],\n \"totalCount\": 2\n}" } ] }, { "name": "Update campaign", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.updatecampaignsresponse.v4+json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"bidding\": {\n \"bidOptimization\": true\n },\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"string\",\n \"state\": \"ENABLED\",\n \"startDate\": \"2023-06-15\",\n \"budget\": 100\n }\n ]\n}" }, "url": "{{api_url}}/sb/v4/campaigns" }, "response": [ { "name": "Update budget", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.updatecampaignsresponse.v4+json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"bidding\": {\n \"bidOptimization\": true\n },\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"string\",\n \"state\": \"ENABLED\",\n \"startDate\": \"2023-06-15\",\n \"budget\": 100\n }\n ]\n}" }, "url": "{{api_url}}/sb/v4/campaigns" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Mar 2023 22:22:18 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "411" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "87GWMF4V56CDD8NR2FYY" }, { "key": "x-amzn-RequestId", "value": "e195ca5a-6778-4083-97b2-682d5d41a33f" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "888d9714-7df2-4738-8bb6-11bbd1c4ed26" }, { "key": "x-amzn-Remapped-Content-Length", "value": "411" }, { "key": "x-amz-apigw-id", "value": "CJwkJHE0IAMF7PA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-641a2e1a-a898b20ad8596a3844690d94" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Mar 2023 22:22:18 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY21DWFJV45CH71\",\n \"budget\": 100,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"203755086457166\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"string\",\n \"productLocation\": \"SOLD_ON_AMAZON\",\n \"startDate\": \"2023-06-15\",\n \"state\": \"ENABLED\"\n },\n \"campaignId\": \"203755086457166\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Delete campaign", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sb/v4/campaigns/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcampaignresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"{{campaignId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sb/v4/campaigns/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 30 Mar 2023 16:18:10 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "397" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "BB8DXK9CJ174Z3TE60HE" }, { "key": "x-amzn-RequestId", "value": "5f7d7dd3-ac05-4c8a-b505-7a822b5f00f1" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "8d9794ce-0513-4e67-85ae-cd36e0abfcdd" }, { "key": "x-amzn-Remapped-Content-Length", "value": "397" }, { "key": "x-amz-apigw-id", "value": "CmlqcEUtoAMFggQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6425b642-a1b0c476c8d27353a39d6f98" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 30 Mar 2023 16:18:09 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"campaigns\": {\n \"error\": [],\n \"success\": [\n {\n \"campaign\": {\n \"bidding\": {\n \"bidOptimization\": true,\n \"bidOptimizationStrategy\": \"MAXIMIZE_IMMEDIATE_SALES\"\n },\n \"brandEntityId\": \"ENTITY21DWFJV45CH71\",\n \"budget\": 50,\n \"budgetType\": \"DAILY\",\n \"campaignId\": \"38789817437281\",\n \"isMultiAdGroupsEnabled\": true,\n \"name\": \"Campaign - 2/20/2023 22:26:18\",\n \"startDate\": \"2023-02-20\",\n \"state\": \"ARCHIVED\"\n },\n \"campaignId\": \"38789817437281\",\n \"index\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Ad groups", "item": [ { "name": "Create ad groups", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save campaignId for first object to environment*/", "if (response.adGroups.success[0] != null ) {", "var adGroupId = response.adGroups.success[0].adGroupId", "postman.clearEnvironmentVariable(\"adGroupId\");", "postman.setEnvironmentVariable(\"adGroupId\", adGroupId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"Name for ad group\",\n \"state\": \"ENABLED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/adGroups" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"name of ad group\",\n \"state\": \"ENABLED\"\n }\n ]\n}" }, "url": "{{api_url}}/sb/beta/adGroups" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:30:01 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "303" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "SHVNZHDQRZ5JVWVG1AQS" }, { "key": "x-amzn-RequestId", "value": "29f6acd1-2842-43c4-b2a7-286d2d832d4a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "0e93e00d-0ab9-4fa7-adb1-4a9b086744b4" }, { "key": "x-amzn-Remapped-Content-Length", "value": "303" }, { "key": "x-amz-apigw-id", "value": "Ziz9_H0mIAMFysw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dcd29-2e45b97c7210ec290825930d" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:30:01 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"adGroups\": {\n \"error\": [],\n \"success\": [\n {\n \"adGroup\": {\n \"adGroupId\": \"236888139321097\",\n \"campaignId\": \"50253512169230\",\n \"extendedData\": {\n \"creationDate\": 1664994599715,\n \"lastUpdateDate\": 1664994599715,\n \"servingStatus\": \"CAMPAIGN_PAUSED\"\n },\n \"name\": \"Test ad group\",\n \"state\": \"ENABLED\"\n },\n \"adGroupId\": \"236888139321097\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "List ad groups", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save adGroupId for first object to environemnt*/", "var response = JSON.parse(responseBody);", "var adGroupId = response.adGroups[0].adGroupId", "postman.clearEnvironmentVariable(\"adGroupId\");", "postman.setEnvironmentVariable(\"adGroupId\", adGroupId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"includeExtendedDataFields\": true,\n \"campaignIdFilter\": {\n \"include\": []\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n ]\n },\n \"nameFilter\": {\n \"queryTermMatchType\": \"EXACT_MATCH\",\n \"include\": []\n }\n}" }, "url": "{{api_url}}/sb/v4/adGroups/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"includeExtendedDataFields\": true,\n \"campaignIdFilter\": {\n \"include\": []\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n ]\n },\n \"nameFilter\": {\n \"queryTermMatchType\": \"EXACT_MATCH\",\n \"include\": []\n }\n}" }, "url": "{{api_url}}/sb/beta/adGroups/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:30:19 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "741" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "W51T4Z5BPS6K125AGAHP" }, { "key": "x-amzn-RequestId", "value": "e42c9342-29d5-4e21-8eb4-c018c824e944" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3f1c110f-b918-482f-8bef-7e86d214de6b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "741" }, { "key": "x-amz-apigw-id", "value": "Zi0BBHaiIAMF59Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dcd39-7fda32f55bc033569c4de536" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:30:19 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"adGroups\": [\n {\n \"adGroupId\": \"144346139432941903\",\n \"campaignId\": \"144327786111035248\",\n \"extendedData\": {\n \"creationDate\": 1635983604000,\n \"lastUpdateDate\": 1635983604000,\n \"servingStatus\": \"CAMPAIGN_INCOMPLETE\"\n },\n \"name\": \"SbTestCampaign-02/11/2021 20:26:06\",\n \"state\": \"ENABLED\"\n },\n {\n \"adGroupId\": \"144370821579495226\",\n \"campaignId\": \"144140792417656013\",\n \"extendedData\": {\n \"creationDate\": 1636727115000,\n \"lastUpdateDate\": 1636727145000,\n \"servingStatus\": \"AD_GROUP_STATUS_ENABLED\"\n },\n \"name\": \"SbTestCampaign-12/11/2021 14:24:44\",\n \"state\": \"ENABLED\"\n },\n {\n \"adGroupId\": \"236888139321097\",\n \"campaignId\": \"50253512169230\",\n \"extendedData\": {\n \"creationDate\": 1664994599715,\n \"lastUpdateDate\": 1664994599715,\n \"servingStatus\": \"CAMPAIGN_PAUSED\"\n },\n \"name\": \"Test ad group\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalResults\": 3\n}" } ] }, { "name": "List ad groups Copy", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save adGroupId for first object to environemnt*/", "var response = JSON.parse(responseBody);", "var adGroupId = response.adGroups[0].adGroupId", "postman.clearEnvironmentVariable(\"adGroupId\");", "postman.setEnvironmentVariable(\"adGroupId\", adGroupId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "" }, "url": "{{api_url}}/sb/adGroups" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"includeExtendedDataFields\": true,\n \"campaignIdFilter\": {\n \"include\": []\n },\n \"stateFilter\": {\n \"include\": [\n \"ENABLED\"\n ]\n },\n \"maxResults\": 10,\n \"adGroupIdFilter\": {\n \"include\": [\n ]\n },\n \"nameFilter\": {\n \"queryTermMatchType\": \"EXACT_MATCH\",\n \"include\": []\n }\n}" }, "url": "{{api_url}}/sb/beta/adGroups/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:30:19 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "741" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "W51T4Z5BPS6K125AGAHP" }, { "key": "x-amzn-RequestId", "value": "e42c9342-29d5-4e21-8eb4-c018c824e944" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3f1c110f-b918-482f-8bef-7e86d214de6b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "741" }, { "key": "x-amz-apigw-id", "value": "Zi0BBHaiIAMF59Q=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dcd39-7fda32f55bc033569c4de536" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:30:19 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"adGroups\": [\n {\n \"adGroupId\": \"144346139432941903\",\n \"campaignId\": \"144327786111035248\",\n \"extendedData\": {\n \"creationDate\": 1635983604000,\n \"lastUpdateDate\": 1635983604000,\n \"servingStatus\": \"CAMPAIGN_INCOMPLETE\"\n },\n \"name\": \"SbTestCampaign-02/11/2021 20:26:06\",\n \"state\": \"ENABLED\"\n },\n {\n \"adGroupId\": \"144370821579495226\",\n \"campaignId\": \"144140792417656013\",\n \"extendedData\": {\n \"creationDate\": 1636727115000,\n \"lastUpdateDate\": 1636727145000,\n \"servingStatus\": \"AD_GROUP_STATUS_ENABLED\"\n },\n \"name\": \"SbTestCampaign-12/11/2021 14:24:44\",\n \"state\": \"ENABLED\"\n },\n {\n \"adGroupId\": \"236888139321097\",\n \"campaignId\": \"50253512169230\",\n \"extendedData\": {\n \"creationDate\": 1664994599715,\n \"lastUpdateDate\": 1664994599715,\n \"servingStatus\": \"CAMPAIGN_PAUSED\"\n },\n \"name\": \"Test ad group\",\n \"state\": \"ENABLED\"\n }\n ],\n \"totalResults\": 3\n}" } ] }, { "name": "Update ad groups", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"adGroupId\": \"{{adGroupId}}\",\n \"state\": \"ENABLED\"\n }\n ]\n}" }, "url": "{{api_url}}/sb/beta/adGroups" }, "response": [ { "name": "Update state", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"adGroupId\": \"236888139321097\",\n \"state\": \"ENABLED\"\n }\n ]\n}" }, "url": "{{api_url}}/sb/beta/adGroups" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:36:56 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "303" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "TQRA7PDDPENDNC0PX0CY" }, { "key": "x-amzn-RequestId", "value": "93d86c3f-7064-45f7-aa8d-968819b369e3" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "eccafa96-8c49-4723-8869-6a391ea0dbab" }, { "key": "x-amzn-Remapped-Content-Length", "value": "303" }, { "key": "x-amz-apigw-id", "value": "Zi0-0GrFIAMFcAg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dcec5-c6cf56b45c4e656e9640e975" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:36:56 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"adGroups\": {\n \"error\": [],\n \"success\": [\n {\n \"adGroup\": {\n \"adGroupId\": \"236888139321097\",\n \"campaignId\": \"50253512169230\",\n \"extendedData\": {\n \"creationDate\": 1664994599715,\n \"lastUpdateDate\": 1664994599715,\n \"servingStatus\": \"CAMPAIGN_PAUSED\"\n },\n \"name\": \"Test ad group\",\n \"state\": \"ENABLED\"\n },\n \"adGroupId\": \"236888139321097\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Delete ad groups", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroupIdFilter\": {\n \"include\": [\n \"{{adGroupId}}\"\n ]\n }\n}" }, "url": "{{api_url}}/sb/beta/adGroups/delete" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadgroupresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroupIdFilter\": {\n \"include\": [\n \"236888139321097\"\n ]\n }\n}" }, "url": "{{api_url}}/sb/beta/adGroups/delete" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 05 Oct 2022 18:37:38 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "304" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QNRGJ172AN5VNGAXKTPQ" }, { "key": "x-amzn-RequestId", "value": "f2d7205f-730d-4efb-9a5e-51f876a48cf2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "d11453ba-d857-4363-b45f-5b6c1f392775" }, { "key": "x-amzn-Remapped-Content-Length", "value": "304" }, { "key": "x-amz-apigw-id", "value": "Zi1FXEIGoAMFnXw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-633dcef2-cbc547d0e86667f84edb1e53" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 05 Oct 2022 18:37:38 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"adGroups\": {\n \"error\": [],\n \"success\": [\n {\n \"adGroup\": {\n \"adGroupId\": \"236888139321097\",\n \"campaignId\": \"50253512169230\",\n \"extendedData\": {\n \"creationDate\": 1664994599715,\n \"lastUpdateDate\": 1664995057306,\n \"servingStatus\": \"CAMPAIGN_PAUSED\"\n },\n \"name\": \"Test ad group\",\n \"state\": \"ARCHIVED\"\n },\n \"adGroupId\": \"236888139321097\",\n \"index\": 0\n }\n ]\n }\n}" } ] } ] }, { "name": "Ads", "item": [ { "name": "Create product collection ad", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "if (response.ads.success[0] != null ) {", "var adId = response.ads.success[0].adId", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\" : \"https://www.amazon.com/stores/page/xxxxxxxx\"\n },\n \"name\": \"Name of product collection\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandLogoCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"brandName\": \"My Brand\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.xxxxxx\",\n \"customImageCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 630\n },\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxx\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/productCollection" }, "response": [ { "name": "Product list success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"pageType\": \"PRODUCT_LIST\"\n },\n \"name\": \"Name for product collection ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandLogoCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"brandName\": \"My Brand\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.xxxxxx\",\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxx\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/productCollection" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 10 Mar 2023 23:30:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1024" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "VTGEYYCR7THTRS57HFXC" }, { "key": "x-amzn-RequestId", "value": "c53f077f-7b16-4fad-8df0-f25211453343" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "91a96f21-80b8-495c-8b55-eba9c361748c" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1024" }, { "key": "x-amz-apigw-id", "value": "BlqRDHB9oAMFdMQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-640bbda1-5e25150a2c436327024cc450" }, { "key": "x-amzn-Remapped-Date", "value": "Fri, 10 Mar 2023 23:30:40 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"194673602531002\",\n \"adId\": \"93865000442586\",\n \"campaignId\": \"38535897458758\",\n \"creative\": {\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxxx:version_v1\",\n \"brandLogoUrl\": \"https://m.media-amazon.com/images/S/xxxxxxxx.jpeg\",\n \"brandName\": \"My Brand\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\",\n \"customImageUrl\": \"https://m.media-amazon.com/images/S/xxxxxxxx.jpeg\",\n \"headline\": \"My headline\",\n \"type\": \"PRODUCT_COLLECTION\"\n },\n \"extendedData\": {\n \"creationDate\": 1678491041228,\n \"lastUpdateDate\": 1678491041491,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"PRODUCT_LIST\",\n \"url\": \"https://www.amazon.com/stores/page/248DF918-E3FB-470A-9B7C-B0280F61F23F\"\n },\n \"name\": \"Test seller product collection\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"93865000442586\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Store success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"pageType\": \"STORE\"\n },\n \"name\": \"name of product collection ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandLogoCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"brandName\": \"My Brand\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\",\n \"customImageCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 630\n },\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/productCollection" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 22 Mar 2023 22:18:04 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1024" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "KSC8YBKW4VYJY4G1B7CS" }, { "key": "x-amzn-RequestId", "value": "dae0739e-4ad5-4a63-a98a-5067aa7650fc" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "fc15cafa-cb8b-4743-acf9-a57a6d3dc244" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1024" }, { "key": "x-amz-apigw-id", "value": "CNC4MGgAIAMFXJA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-641b7e9c-fbc894a64554712e9d402eca" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 22 Mar 2023 22:18:04 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"99770401373052\",\n \"adId\": \"171499375771502\",\n \"campaignId\": \"80952013810414\",\n \"creative\": {\n \"asins\": [\n \"B004QF0TFQ\",\n \"B0787FVB5F\",\n \"B00JVTNWB0\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.36de5ea70704fc6372038cf1d3917540:version_v1\",\n \"brandLogoUrl\": \"https://m.media-amazon.com/images/S/xxxxxxxx.jpeg\",\n \"brandName\": \"Socks4Less\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.e59e684e7bdc380ca20e2cebb375adf5:version_v1\",\n \"customImageUrl\": \"https://m.media-amazon.com/images/S/xxxxxxxx.jpg\",\n \"headline\": \"My headline\",\n \"type\": \"PRODUCT_COLLECTION\"\n },\n \"extendedData\": {\n \"creationDate\": 1679523484141,\n \"lastUpdateDate\": 1679523484410,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"PRODUCT_LIST\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxx\"\n },\n \"name\": \"Test vendor product collection\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"171499375771502\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Custom_URL success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"pageType\": \"CUSTOM_URL\",\n \"url\": \"https://www.amazon.com/stores/page/0064AC34-18F6-4CD3-849F-531E7C5AE8D6\"\n },\n \"name\": \"Name of product collection ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandLogoCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 0,\n \"height\": 0\n },\n \"asins\": [\n \"B08MV395Y1\",\n \"B08VGX1BXG\",\n \"B08VGYL7BM\"\n ],\n \"brandName\": \"Socks4Less\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.e59e684e7bdc380ca20e2cebb375adf5:version_v1\",\n \"customImageCrop\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 630\n },\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.36de5ea70704fc6372038cf1d3917540:version_v1\",\n \"headline\": \"High quality socks\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/productCollection" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 22 Mar 2023 22:46:34 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1017" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "T6D5S02F7NA4YZPC6B5Y" }, { "key": "x-amzn-RequestId", "value": "2dea6c8b-a8a0-4cf4-826c-ec28ae8f9a2a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "3eb66a33-2dcf-4dcf-9d1e-83c6210ef52b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1017" }, { "key": "x-amz-apigw-id", "value": "CNHDfHHqIAMFc_w=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-641b854a-ce0a67847f52cbf37972d372" }, { "key": "x-amzn-Remapped-Date", "value": "Wed, 22 Mar 2023 22:46:33 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"42098488277205\",\n \"adId\": \"279885644138915\",\n \"campaignId\": \"80952013810414\",\n \"creative\": {\n \"asins\": [\n \"B08MV395Y1\",\n \"B08VGX1BXG\",\n \"B08VGYL7BM\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxxxx:version_v1\",\n \"brandLogoUrl\": \"https://m.media-amazon.com/images/S/xxxxxxjpeg\",\n \"brandName\": \"Socks4Less\",\n \"customImageAssetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxx:version_v1\",\n \"customImageUrl\": \"https://m.media-amazon.com/images/S/xxxxxxxxxjpg\",\n \"headline\": \"High quality socks\",\n \"type\": \"PRODUCT_COLLECTION\"\n },\n \"extendedData\": {\n \"creationDate\": 1679525193742,\n \"lastUpdateDate\": 1679525194000,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxxx\"\n },\n \"name\": \"Test vendor product collection\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"279885644138915\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Create product collection extended", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "if (response.ads.success[0] != null ) {", "var adId = response.ads.success[0].adId", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"asins\": [\n \"B0CGY22J6Y\",\n \"B0CGY4QJTC\",\n \"B0CGY1MQFD\",\n \"B0BVYTJFLY\",\n \"B0B6963LJN\"\n ],\n \"pageType\": \"PRODUCT_LIST\"\n },\n \"name\": \"name of ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandLogoCrop\": {\n \"height\": 768,\n \"left\": 0,\n \"top\": 0,\n \"width\": 768\n },\n \"asins\": [\n \"B0CGY1MQFD\",\n \"B0BVYTJFLY\",\n \"B0B6963LJN\"\n ],\n \"brandName\": \"name of brand\",\n \"customImages\": [\n {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\",\n \"crop\": {\n \"height\": 628,\n \"left\": 0,\n \"top\": 0,\n \"width\": 1200\n },\n \"url\": \"https://m.media-amazon.com/images/S/sample.jpeg\"\n }\n ],\n \"consentToTranslate\": false,\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxx:version_v1\",\n \"headline\": \"Find the Perfect LEGO® Gift for Boys of All Ages\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/productCollectionExtended" }, "response": [] }, { "name": "Create video ad", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "if (response.ads.success[0] != null ) {", "var adId = response.ads.success[0].adId", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"name\": \"Name of video ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"asins\": [\n \"B07R7V6KS8\"\n ],\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxx\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/video" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"name\": \"Name of video ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"asins\": [\n \"B07R7V6KS8\"\n ],\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxx\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/video" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 07 Mar 2023 01:19:15 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "536" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "TE2CCGGWEJF3RH4VD0HA" }, { "key": "x-amzn-RequestId", "value": "103df5c9-d889-4f4d-b19c-b98bf34dac4c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "e0e020dc-ff5b-4916-8269-cf5db0a56259" }, { "key": "x-amzn-Remapped-Content-Length", "value": "536" }, { "key": "x-amz-apigw-id", "value": "BYua_Hf0IAMFqhQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64069113-4fe19e6b04b9e1a4a16fc12e" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 07 Mar 2023 01:19:15 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"233241812140955\",\n \"adId\": \"193008782828097\",\n \"campaignId\": \"38535897458758\",\n \"creative\": {\n \"asins\": [\n \"B07R7V6KS8\"\n ],\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxxxx:version_v1\"\n ]\n },\n \"extendedData\": {\n \"creationDate\": 1678151955357,\n \"lastUpdateDate\": 1678151955627,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"DETAIL_PAGE\",\n \"url\": \"https://www.amazon.com/dp/xxxxxxxx\"\n },\n \"name\": \"Test video ad\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"193008782828097\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Create brand video ad", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "if (response.ads.success[0] != null ) {", "var adId = response.ads.success[0].adId", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxxxx\"\n },\n \"name\": \"Name of brand video ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxx\"\n ],\n \"brandName\": \"My brand\",\n \"brandLogoAssetID\": \"amzn1.assetlibrary.xxxxxx\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/brandVideo" }, "response": [ { "name": "Store success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxx\"\n },\n \"name\": \"name of brand video ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxxx:version_v1\"\n ],\n \"brandName\": \"My brand\",\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxx:version_v1\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/brandVideo" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 13 Mar 2023 20:22:11 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "747" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "SZ52V70RXHR22R4P5MC9" }, { "key": "x-amzn-RequestId", "value": "60df5cfe-fbea-4ee9-b4af-7a1a279d7f6d" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "fe03c73f-ade3-420b-b163-7607f73d1ba6" }, { "key": "x-amzn-Remapped-Content-Length", "value": "747" }, { "key": "x-amz-apigw-id", "value": "BvHduEDkIAMF7Jw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-640f85f3-db233f62bfbb876bfb4455a8" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 13 Mar 2023 20:22:11 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"155603752538210\",\n \"adId\": \"139895623764517\",\n \"campaignId\": \"157902658409454\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\",\n \"brandName\": \"My brand\",\n \"headline\": \"My headline\",\n \"type\": \"BRAND_VIDEO\",\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxxx\"\n ]\n },\n \"extendedData\": {\n \"creationDate\": 1678738930312,\n \"lastUpdateDate\": 1678738930594,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxxx\"\n },\n \"name\": \"Test video ad\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"139895623764517\",\n \"index\": 0\n }\n ]\n }\n}" }, { "name": "Detail_page success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"pageType\": \"DETAIL_PAGE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxx\"\n },\n \"name\": \"Name of brand video ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\"\n ],\n \"brandName\": \"My brand\",\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxx:version_v1\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/brandVideo" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 23 Mar 2023 00:28:37 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "743" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "2SR4HMKWFPKHZFMMA1ZA" }, { "key": "x-amzn-RequestId", "value": "98696cdb-8c6b-4400-b80d-1afe38c4b0a8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "66b91f9d-5284-48ab-b31f-9032999e68fa" }, { "key": "x-amzn-Remapped-Content-Length", "value": "743" }, { "key": "x-amz-apigw-id", "value": "CNV__FSbIAMFqHg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-641b9d35-f7bae61269a9a36b72398eb0" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 23 Mar 2023 00:28:36 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"56304154454004\",\n \"adId\": \"89501604414217\",\n \"campaignId\": \"32387503176861\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxxxx:version_v1\",\n \"brandName\": \"My brand\",\n \"headline\": \"My headline\",\n \"type\": \"BRAND_VIDEO\",\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxx\"\n ]\n },\n \"extendedData\": {\n \"creationDate\": 1679531316035,\n \"lastUpdateDate\": 1679531316288,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxx\"\n },\n \"name\": \"Test video ad\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"89501604414217\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "Create store spotlight ad", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "if (response.ads.success[0] != null ) {", "var adId = response.ads.success[0].adId", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"url\": \"https://www.amazon.com/stores/page/0064AC34-18F6-4CD3-849F-531E7C5AE8D6\"\n },\n \"name\": \"Name for store spotlight\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandName\": \"My brand name\",\n \"subpages\": [\n {\n \"pageTitle\": \"Savannah\",\n \"asin\": \"B08MV395Y1\",\n \"url\": \"https://www.amazon.com/stores/page/2B2AE9C7-7EF4-4993-AA76-0FFF7EF7D050\"\n },\n {\n \"pageTitle\": \"Miami\",\n \"asin\": \"B08VGX1BXG\",\n \"url\": \"https://www.amazon.com/stores/page/E411CCC7-B125-4076-A476-197441A2A23E\"\n },\n {\n \"pageTitle\": \"San Fran\",\n \"asin\": \"B08VGYL7BM\",\n \"url\": \"https://www.amazon.com/stores/page/BE713C9E-F85F-4461-B42A-29740F5B61F5\"\n }\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxx\",\n \"headline\": \"Cheap pants\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/storeSpotlight" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"landingPage\": {\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxx\"\n },\n \"name\": \"name of store spotlight ad\",\n \"state\": \"ENABLED\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"creative\": {\n \"brandName\": \"My store\",\n \"subpages\": [\n {\n \"pageTitle\": \"Savannah\",\n \"asin\": \"B08MV395Y1\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxx\"\n },\n {\n \"pageTitle\": \"Miami\",\n \"asin\": \"B08VGX1BXG\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxx\"\n },\n {\n \"pageTitle\": \"San Fran\",\n \"asin\": \"B08VGYL7BM\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxx\"\n }\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxx:version_v1\",\n \"headline\": \"My headline\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/v4/ads/storeSpotlight" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 14 Mar 2023 16:48:23 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1006" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "5V4EW676Y1M76TMT0MEV" }, { "key": "x-amzn-RequestId", "value": "33d0e022-1371-4c8f-af05-fe137f0639d6" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "e2c7593a-474c-4b6c-bb23-d9be68f50d5b" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1006" }, { "key": "x-amz-apigw-id", "value": "Bx7EeHYYIAMFlsA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6410a557-26f8f6cdd444d79be40aeee1" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 14 Mar 2023 16:48:22 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"ads\": {\n \"error\": [],\n \"success\": [\n {\n \"ad\": {\n \"adGroupId\": \"72598658504351\",\n \"adId\": \"185980120883864\",\n \"campaignId\": \"203755086457166\",\n \"creative\": {\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxx:version_v1\",\n \"brandName\": \"My store\",\n \"headline\": \"Cheap pants\",\n \"subpages\": [\n {\n \"asin\": \"B08MV395Y1\",\n \"pageTitle\": \"Savannah\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxxx\"\n },\n {\n \"asin\": \"B08VGX1BXG\",\n \"pageTitle\": \"Miami\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxx\"\n },\n {\n \"asin\": \"B08VGYL7BM\",\n \"pageTitle\": \"San Fran\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxxxx\"\n }\n ],\n \"type\": \"STORE_SPOTLIGHT\"\n },\n \"extendedData\": {\n \"creationDate\": 1678812501793,\n \"lastUpdateDate\": 1678812502131,\n \"servingStatus\": \"AD_POLICING_PENDING_REVIEW\"\n },\n \"landingPage\": {\n \"pageType\": \"STORE\",\n \"url\": \"https://www.amazon.com/stores/page/xxxxxx\"\n },\n \"name\": \"test landing store\",\n \"state\": \"ENABLED\"\n },\n \"adId\": \"185980120883864\",\n \"index\": 0\n }\n ]\n }\n}" } ] }, { "name": "List ads", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save adId for first object to environemnt*/", "var response = JSON.parse(responseBody);", "var adId = response.ads[0].adId", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "" }, "url": "{{api_url}}/sb/v4/ads/list" }, "response": [] }, { "name": "Update ads", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"adId\": \"{{adId}}\",\n \"name\": \"New ad name\",\n \"state\": \"PAUSED\"\n }\n ]\n}\n\n" }, "url": "{{api_url}}/sb/v4/ads" }, "response": [] }, { "name": "Delete ads", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adIdFilter\": {\n \"include\": [\n \"{{adId}}\"\n ]\n }\n}\n\n" }, "url": "{{api_url}}/sb/v4/ads/delete" }, "response": [] } ] }, { "name": "Targeting", "item": [ { "name": "Recommendations", "item": [ { "name": "Get product recommendations", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"maxResults\": 5,\n \"filters\": [\n {\n \"filterType\": \"ASINS\",\n \"values\": [\n \"B07YT8NVF9\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/targets/product/list" }, "response": [ { "name": "Recommended products", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"maxResults\": 5,\n \"filters\": [\n {\n \"filterType\": \"ASINS\",\n \"values\": [\n \"B07YT8NVF9\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/targets/product/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 14 Jul 2023 19:03:23 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbproductrecommendationsresponse.v3.1+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "TZJF87EC656HFAHB06D5" }, { "key": "x-amz-request-id", "value": "TZJF87EC656HFAHB06D5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"nextToken\": \"/u0NEl5BpwIAAAAAAAAAAXmoRxxl/XqL3LOy+KBHD9EohL8AI1vWqYty8J/ojtCV+BY7IbhguHT15K4NMQRy77nR35CqAlf5HKhjBkbMhhVoQqxXLJUciz9DQfMIFZ6DJ5BjiqEWw1bEdm4sKApkHuM/w2PVRbewCfibM4Yzp7uiVpM4WpjVN1fpe5qqjf2dMNRJd/PMPitIiE81aPJ8SudZegVH5lvNvVhuC3oF/08Md0MqSq2ifq5WcIuT4il/UweRuZv9X6ng6tT8JTfLOEUHjx0EmFHJbkC8ifgvcnuHJ57j4QlYicIlqUrtiiBLxot+ewqdtodrDVfQnKdK5oZ66M/cGj+TOMi2IqgnrPuzvHFkVyW0eX2cB6oMNrl8Au4N1CvY2E776EaaRYPCvtl/rC/Xes5jjra7Wye/1iQ=\",\n \"recommendedProducts\": [\n {\n \"recommendedTargetAsin\": \"B00IO9H8GI\"\n },\n {\n \"recommendedTargetAsin\": \"B07R213ZR3\"\n },\n {\n \"recommendedTargetAsin\": \"B0925X68D6\"\n },\n {\n \"recommendedTargetAsin\": \"B0735DQFPK\"\n },\n {\n \"recommendedTargetAsin\": \"B07HRD9BQB\"\n }\n ]\n}" } ] }, { "name": "Get keyword recommendations", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://www.amazon.com/stores/page/1F55C506-459C-42B7-885B-86A3EA96A582\",\n \"maxNumSuggestions\": \"3\",\n \"creativeType\": \"PRODUCT_COLLECTION\",\n \"creativeAsins\" : [\n \"B00JVTNWB0\",\n \"B0787FVB5F\",\n \"B004QF0TFQ\"\n ],\n \"locale\": \"zh_CN\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/keyword" }, "response": [ { "name": "Get keyword recommendations for list of ASINS", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"asins\": [\n \"B00JVTNWB0\",\n \"B0787FVB5F\",\n \"B004QF0TFQ\"\n ],\n \"maxNumSuggestions\": \"3\",\n \"creativeType\": \"PRODUCT_COLLECTION\",\n \"creativeAsins\" : [\n \"B00JVTNWB0\",\n \"B0787FVB5F\",\n \"B004QF0TFQ\"\n ],\n \"locale\": \"zh_CN\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/keyword" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 17 May 2023 23:15:26 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "656" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1CB9WNNZV8K2HBERPMJE" }, { "key": "x-amzn-RequestId", "value": "793d518f-848a-4cbd-9458-ac1cba778b38" }, { "key": "x-amz-apigw-id", "value": "FFvySFC-oAMF_Wg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6465600e-cefe7594d5d04cbdacbc96e8" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"recommendationId\": \"8b6e905435fc700f2033de731a429429\",\n \"type\": \"addKeyword\",\n \"value\": \"mens socks\",\n \"translation\": \"男士袜子\",\n \"matchType\": \"PHRASE\",\n \"searchTermImpressionShare\": null,\n \"searchTermImpressionRank\": null\n },\n {\n \"recommendationId\": \"5cb57c0e663281f2c86fb2718dda1e6e\",\n \"type\": \"addKeyword\",\n \"value\": \"socks for men\",\n \"translation\": \"男士袜子\",\n \"matchType\": \"PHRASE\",\n \"searchTermImpressionShare\": null,\n \"searchTermImpressionRank\": null\n },\n {\n \"recommendationId\": \"fbce90ea015b6bf23e1f02cd9a0d4813\",\n \"type\": \"addKeyword\",\n \"value\": \"mens adidas socks\",\n \"translation\": \"男士阿迪达斯袜\",\n \"matchType\": \"PHRASE\",\n \"searchTermImpressionShare\": null,\n \"searchTermImpressionRank\": null\n }\n]" }, { "name": "Get keyword recommendations for URL", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://www.amazon.com/stores/page/1F55C506-459C-42B7-885B-86A3EA96A582\",\n \"maxNumSuggestions\": \"3\",\n \"creativeType\": \"PRODUCT_COLLECTION\",\n \"creativeAsins\" : [\n \"B00JVTNWB0\",\n \"B0787FVB5F\",\n \"B004QF0TFQ\"\n ],\n \"locale\": \"zh_CN\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/keyword" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 17 May 2023 23:20:48 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "656" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "DXWTE09F86RRQA7QW1NB" }, { "key": "x-amzn-RequestId", "value": "7c019e31-0979-463f-8e21-584e34da46e8" }, { "key": "x-amz-apigw-id", "value": "FFwkaG-0IAMFfDA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64656150-a00668b075e605d98088e4a2" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"recommendationId\": \"3a36b7606bf464dc1307d5ff21c6f673\",\n \"type\": \"addKeyword\",\n \"value\": \"mens socks\",\n \"translation\": \"男士袜子\",\n \"matchType\": \"PHRASE\",\n \"searchTermImpressionShare\": null,\n \"searchTermImpressionRank\": null\n },\n {\n \"recommendationId\": \"e03a604f8a583570351db13fb3c53185\",\n \"type\": \"addKeyword\",\n \"value\": \"socks for men\",\n \"translation\": \"男士袜子\",\n \"matchType\": \"PHRASE\",\n \"searchTermImpressionShare\": null,\n \"searchTermImpressionRank\": null\n },\n {\n \"recommendationId\": \"58714673c0d4323add41d6f70dcc3c0c\",\n \"type\": \"addKeyword\",\n \"value\": \"mens adidas socks\",\n \"translation\": \"男士阿迪达斯袜\",\n \"matchType\": \"PHRASE\",\n \"searchTermImpressionShare\": null,\n \"searchTermImpressionRank\": null\n }\n]" } ] }, { "name": "Recommended categories for targeting", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcategoryrecommendationsresponse.v3.2+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"asins\": [\n \"B00G96S4Y8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/targets/category" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbcategoryrecommendationsresponse.v3.2+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"asins\": [\n \"B00G96S4Y8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/targets/category" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 17 Jul 2023 15:56:00 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbcategoryrecommendationsresponse.v3.2+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EYN51JDH3749GWCBMX1Z" }, { "key": "x-amz-request-id", "value": "EYN51JDH3749GWCBMX1Z" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"categoryRecommendationResults\": [\n {\n \"id\": 19240644011,\n \"name\": \"Indoor Electric Space Heaters\",\n \"path\": \"/Home & Kitchen/Heating, Cooling & Air Quality/Indoor Space Heaters/Indoor Electric Space Heaters\",\n \"isTargetable\": true\n },\n {\n \"id\": 1055398,\n \"name\": \"Home & Kitchen\",\n \"path\": \"/Home & Kitchen\",\n \"isTargetable\": true\n },\n {\n \"id\": 3206324011,\n \"name\": \"Heating, Cooling & Air Quality\",\n \"path\": \"/Home & Kitchen/Heating, Cooling & Air Quality\",\n \"isTargetable\": true\n },\n {\n \"id\": 510182,\n \"name\": \"Indoor Space Heaters\",\n \"path\": \"/Home & Kitchen/Heating, Cooling & Air Quality/Indoor Space Heaters\",\n \"isTargetable\": true\n }\n ]\n}" } ] }, { "name": "Get bid recommendations for targets", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": " {\n \"campaignId\": {{campaignId}},\n \"targets\": [\n [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n }\n ]\n ],\n \"adFormat\": \"productCollection\"\n } ", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/bids" }, "response": [ { "name": "By ASIN", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": " {\n \"campaignId\": {{campaignId}},\n \"targets\": [\n [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B084311KKN\"\n }\n ]\n ],\n \"adFormat\": \"productCollection\"\n } ", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/bids" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 14 Jul 2023 21:04:25 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbbidsrecommendation.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7GT46XZ8BKNACHWGW8ZX" }, { "key": "x-amz-request-id", "value": "7GT46XZ8BKNACHWGW8ZX" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"keywordsBidsRecommendationSuccessResults\": [],\n \"keywordsBidsRecommendationErrorResults\": [],\n \"targetsBidsRecommendationSuccessResults\": [\n {\n \"targets\": [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B084311KKN\"\n }\n ],\n \"targetsIndex\": 0,\n \"recommendationId\": \"05729efc9d3f81a039dededf07684456\",\n \"recommendedBid\": {\n \"rangeStart\": 1.45,\n \"rangeEnd\": 6.46,\n \"recommended\": 2.68\n }\n }\n ],\n \"targetsBidsRecommendationErrorResults\": [],\n \"themesRecommendationSuccessResults\": [],\n \"themesRecommendationErrorResults\": []\n}" }, { "name": "By category", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": " {\n \"campaignId\": {{campaignId}},\n \"targets\": [\n [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n }\n ]\n ],\n \"adFormat\": \"productCollection\"\n } ", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/recommendations/bids" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 14 Jul 2023 21:06:04 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbbidsrecommendation.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "DJYJHH8GSF9THGE6Y1GE" }, { "key": "x-amz-request-id", "value": "DJYJHH8GSF9THGE6Y1GE" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"keywordsBidsRecommendationSuccessResults\": [],\n \"keywordsBidsRecommendationErrorResults\": [],\n \"targetsBidsRecommendationSuccessResults\": [\n {\n \"targets\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n }\n ],\n \"targetsIndex\": 0,\n \"recommendationId\": \"f9cafef70ec838243976893a28be669f\",\n \"recommendedBid\": {\n \"rangeStart\": 0.42,\n \"rangeEnd\": 2.37,\n \"recommended\": 1.25\n }\n }\n ],\n \"targetsBidsRecommendationErrorResults\": [],\n \"themesRecommendationSuccessResults\": [],\n \"themesRecommendationErrorResults\": []\n}" } ] } ] }, { "name": "Theme targeting", "item": [ { "name": "Create theme targeting", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save themeId for first object to environment*/", "if (response.success[0] != null ) {", "var themeId = response.success[0].themeId;", "console.log(themeId);", "postman.clearEnvironmentVariable(\"themeId\");", "postman.setEnvironmentVariable(\"themeId\", themeId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"themes\": [\n {\n \"adGroupId\": \"{{adGroupId}}\",\n \"campaignId\": \"{{campaignId}}\",\n \"themeType\": \"KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\",\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/themes" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"themes\": [\n {\n \"adGroupId\": \"{{adGroupId}}\",\n \"campaignId\": \"{{campaignId}}\",\n \"themeType\": \"KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\",\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/themes" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 14 Aug 2023 18:13:01 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbthemescreateresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JWFWCTYD4CDYVHVCPZTQ" }, { "key": "x-amz-request-id", "value": "JWFWCTYD4CDYVHVCPZTQ" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"success\": [\n {\n \"themeId\": \"374248029885448\",\n \"index\": 0\n }\n ],\n \"error\": []\n}" } ] }, { "name": "Update theme targets", "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"themes\": [\n {\n \"themeId\": \"{{themeId}}\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"campaignId\": \"{{campaignId}}\",\n \"state\": \"enabled\",\n \"bid\": 8.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/themes" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"themes\": [\n {\n \"themeId\": \"{{themeId}}\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"campaignId\": \"{{campaignId}}\",\n \"state\": \"enabled\",\n \"bid\": 8.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/themes" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 14 Aug 2023 18:19:15 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbthemesupdateresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "KHH24BVZATTEXR0253RV" }, { "key": "x-amz-request-id", "value": "KHH24BVZATTEXR0253RV" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"success\": [\n {\n \"themeId\": \"374248029885448\",\n \"index\": 0\n }\n ],\n \"error\": []\n}" } ] }, { "name": "List themes", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"maxResults\": 1,\n \"themeIdFilter\": {\n \"include\": [\n {{themeId}}\n ]\n },\n \"adGroupIdFilter\": {\n \"include\": [\n {{adGroupId}}\n ]\n },\n \"campaignIdFilter\": {\n \"include\": [\n {{campaignId}}\n ]\n },\n \"stateFilter\": {\n \"include\": [\n \"enabled\"\n ]\n },\n \"themeTypeFilter\": {\n \"include\": [\n \"KEYWORDS_RELATED_TO_YOUR_BRAND\",\n \"KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/themes/list" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"maxResults\": 1,\n \"themeIdFilter\": {\n \"include\": [\n {{themeId}}\n ]\n },\n \"adGroupIdFilter\": {\n \"include\": [\n {{adGroupId}}\n ]\n },\n \"campaignIdFilter\": {\n \"include\": [\n {{campaignId}}\n ]\n },\n \"stateFilter\": {\n \"include\": [\n \"enabled\"\n ]\n },\n \"themeTypeFilter\": {\n \"include\": [\n \"KEYWORDS_RELATED_TO_YOUR_BRAND\",\n \"KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/themes/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 14 Aug 2023 18:27:04 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbthemeslistresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JNR8QW2ZP16QH335CCYW" }, { "key": "x-amz-request-id", "value": "JNR8QW2ZP16QH335CCYW" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"themes\": [\n {\n \"themeId\": \"374248029885448\",\n \"adGroupId\": \"291025936425876\",\n \"campaignId\": \"357090364785907\",\n \"themeType\": \"KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\",\n \"state\": \"enabled\",\n \"bid\": 8\n }\n ]\n}" } ] } ] }, { "name": "Create keywords", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save keywordId for first object to environment*/", "if (response[0].keywordId != null ) {", "var keywordId = response[0].keywordId;", "console.log(\"keywordId is: \" + keywordId);", "postman.clearEnvironmentVariable(\"keywordId\");", "postman.setEnvironmentVariable(\"keywordId\", keywordId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordText\": \"soap bar\",\n \"nativeLanguageKeyword\": \"肥皂\",\n \"nativeLanguageLocale\": \"zh_CN\",\n \"matchType\": \"broad\",\n \"bid\": 10\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/keywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordText\": \"shoes\",\n \"nativeLanguageKeyword\": \"shoes\",\n \"nativeLanguageLocale\": \"zh_CN\",\n \"matchType\": \"broad\",\n \"bid\": 10\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/keywords" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 30 Mar 2023 21:26:37 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeywordresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "MCBDGRB9G75MZF049SV0" }, { "key": "x-amz-request-id", "value": "MCBDGRB9G75MZF049SV0" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"keywordId\": 195991635164411\n }\n]" } ] }, { "name": "Update keyword", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordId\": {{keywordId}},\n \"state\": \"enabled\",\n \"bid\": 10\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/keywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordId\": {{keywordId}},\n \"state\": \"enabled\",\n \"bid\": 10\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/keywords" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 21:50:36 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeywordresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "SV11DWHEQ3N0GY6V1RTS" }, { "key": "x-amz-request-id", "value": "SV11DWHEQ3N0GY6V1RTS" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"keywordId\": 296549504515464\n }\n]" } ] }, { "name": "Get keyword", "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/keywords/{{keywordId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/keywords/{{keywordId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 21:53:02 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeyword.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "3H38VCGVWAKV5BNGPP8Y" }, { "key": "x-amz-request-id", "value": "3H38VCGVWAKV5BNGPP8Y" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"keywordId\": 296549504515464,\n \"adGroupId\": 455202456585619,\n \"campaignId\": 373154468548682,\n \"keywordText\": \"soap bar\",\n \"matchType\": \"broad\",\n \"state\": \"enabled\",\n \"bid\": 10\n}" } ] }, { "name": "Delete keyword", "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/keywords/{{keywordId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/keywords/{{keywordId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 21:55:29 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeywordresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QG0SDMZ5BEH0KX511WTZ" }, { "key": "x-amz-request-id", "value": "QG0SDMZ5BEH0KX511WTZ" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"code\": \"SUCCESS\",\n \"keywordId\": 296549504515464\n}" } ] }, { "name": "Create negative keywords", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save keywordId for first object to environment*/", "if (response[0].keywordId != null ) {", "var keywordId = response[0].keywordId;", "console.log(\"negativeKeywordId is: \" + keywordId);", "postman.clearEnvironmentVariable(\"negativeKeywordId\");", "postman.setEnvironmentVariable(\"negativeKeywordId\", keywordId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordText\": \"white socks\",\n \"matchType\": \"negativeExact\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordText\": \"white socks\",\n \"matchType\": \"negativeExact\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 17:34:13 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeywordresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "NZ0K9S5D8W8FJ6W9EKK8" }, { "key": "x-amz-request-id", "value": "NZ0K9S5D8W8FJ6W9EKK8" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"keywordId\": 372405033119784\n }\n]" } ] }, { "name": "Update negative keyword", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordId\": {{negativeKeywordId}},\n \"state\": \"enabled\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"keywordId\": {{negativeKeywordId}},\n \"state\": \"enabled\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 21:58:49 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeywordresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "N5DGX2CAV1XPXYCCG3PK" }, { "key": "x-amz-request-id", "value": "N5DGX2CAV1XPXYCCG3PK" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"keywordId\": 436834611557874\n }\n]" } ] }, { "name": "Get negative keyword", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords/{{negativeKeywordId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/negativeKeywords/{{negativeKeywordId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:00:00 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbnegativekeyword.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ARPT1GFDSWPEC5J034ZB" }, { "key": "x-amz-request-id", "value": "ARPT1GFDSWPEC5J034ZB" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"keywordId\": 436834611557874,\n \"adGroupId\": 455202456585619,\n \"campaignId\": 373154468548682,\n \"keywordText\": \"white socks\",\n \"matchType\": \"negativeExact\",\n \"state\": \"enabled\"\n}" } ] }, { "name": "Delete negative keyword", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords/{{negativeKeywordId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeKeywords/{{negativeKeywordId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:05:46 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbkeywordresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "A8W99YMNRVX5TCE6Y4W5" }, { "key": "x-amz-request-id", "value": "A8W99YMNRVX5TCE6Y4W5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"code\": \"SUCCESS\",\n \"keywordId\": 436834611557874\n}" } ] }, { "name": "Create product targets", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save keywordId for first object to environment*/", "if (response.createTargetSuccessResults[0].targetId != null ) {", "var targetId = response.createTargetSuccessResults[0].targetId;", "console.log(\"targetId is: \" + targetId);", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"expressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ],\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets" }, "response": [ { "name": "One ASIN", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"expressions\": [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 22 Jun 2023 19:41:33 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbcreatetargetsresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "E76DKDT3EVKKSY3Q0PSV" }, { "key": "x-amz-request-id", "value": "E76DKDT3EVKKSY3Q0PSV" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"createTargetSuccessResults\": [\n {\n \"targetRequestIndex\": 0,\n \"targetId\": 381033826504449\n }\n ],\n \"createTargetErrorResults\": []\n}" }, { "name": "Category targeting with refinements", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"expressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ],\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Fri, 14 Jul 2023 18:37:18 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbcreatetargetsresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "N35HMZCV4ZWNTVVWFGZ3" }, { "key": "x-amz-request-id", "value": "N35HMZCV4ZWNTVVWFGZ3" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"createTargetSuccessResults\": [\n {\n \"target\": {\n \"targetId\": 520756961415270,\n \"adGroupId\": 461354338823033,\n \"campaignId\": 138928968665109,\n \"state\": \"enabled\",\n \"bid\": 10,\n \"expressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ],\n \"resolvedExpressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"Paper Dolls\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"Back to Basics\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ]\n },\n \"targetRequestIndex\": 0,\n \"targetId\": 520756961415270\n }\n ],\n \"createTargetErrorResults\": []\n}" } ] }, { "name": "Update a product target", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"targetId\": {{targetId}},\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"state\": \"enabled\",\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"targetId\": {{targetId}},\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"state\": \"enabled\",\n \"bid\": 10.0\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:12:23 GMT" }, { "key": "Content-Type", "value": "application/vnd.updatetargetsresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "Z65DPXE1MV80N3CCWM8T" }, { "key": "x-amz-request-id", "value": "Z65DPXE1MV80N3CCWM8T" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"updateTargetSuccessResults\": [\n {\n \"targetRequestIndex\": 0,\n \"targetId\": 365490413814773,\n \"target\": {\n \"targetId\": 365490413814773,\n \"adGroupId\": 336526170361779,\n \"campaignId\": 373154468548682,\n \"state\": \"enabled\",\n \"bid\": 10,\n \"expressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ],\n \"resolvedExpressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"Paper Dolls\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"Back to Basics\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ]\n }\n }\n ],\n \"updateTargetErrorResults\": []\n}" } ] }, { "name": "Get product target", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets/{{targetId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "url": "{{api_url}}/sb/targets/{{targetId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:14:14 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbtarget.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QJ52VRSNA1F39EP8PFK0" }, { "key": "x-amz-request-id", "value": "QJ52VRSNA1F39EP8PFK0" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"targetId\": 365490413814773,\n \"adGroupId\": 336526170361779,\n \"campaignId\": 373154468548682,\n \"state\": \"enabled\",\n \"bid\": 10,\n \"expressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"2522102011\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"7048034011\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ],\n \"resolvedExpressions\": [\n {\n \"type\": \"asinCategorySameAs\",\n \"value\": \"Paper Dolls\"\n },\n {\n \"type\": \"asinBrandSameAs\",\n \"value\": \"Back to Basics\"\n },\n {\n \"type\": \"asinReviewRatingBetween\",\n \"value\": \"3-4.5\"\n }\n ]\n}" } ] }, { "name": "Delete product target", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets/{{targetId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets/{{targetId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:15:25 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbtargetresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "621JQHVMPPYENGEY6KZD" }, { "key": "x-amz-request-id", "value": "621JQHVMPPYENGEY6KZD" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"code\": \"SUCCESS\",\n \"targetId\": 365490413814773\n}" } ] }, { "name": "Create negative product target", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save keywordId for first object to environment*/", "if (response.createTargetSuccessResults[0].targetId != null ) {", "var negativeTargetId = response.createTargetSuccessResults[0].targetId;", "console.log(\"negativeTargetId is: \" + negativeTargetId);", "postman.clearEnvironmentVariable(\"negativeTargetId\");", "postman.setEnvironmentVariable(\"negativeTargetId\", negativeTargetId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargets\": [\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"expressions\": [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B07YT8NVF9\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeTargets" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargets\": [\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"expressions\": [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B07YT8NVF9\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeTargets" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 21:08:28 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbcreatenegativetargetsrequest.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "57RCCKPPMBNS67WVEJTW" }, { "key": "x-amz-request-id", "value": "57RCCKPPMBNS67WVEJTW" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"createTargetSuccessResults\": [\n {\n \"targetRequestIndex\": 0,\n \"targetId\": 311226698235224\n }\n ],\n \"createTargetErrorResults\": []\n}" } ] }, { "name": "Update negative product target", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargets\": [\n {\n \"targetId\": {{negativeTargetId}},\n \"adGroupId\": {{adGroupId}},\n \"state\": \"enabled\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeTargets" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"negativeTargets\": [\n {\n \"targetId\": {{negativeTargetId}},\n \"adGroupId\": {{adGroupId}},\n \"state\": \"enabled\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/negativeTargets" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:22:48 GMT" }, { "key": "Content-Type", "value": "application/vnd.updatenegativetargetsresponse.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "26HK54X7A9T2VBC239WC" }, { "key": "x-amz-request-id", "value": "26HK54X7A9T2VBC239WC" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"updateTargetSuccessResults\": [\n {\n \"targetRequestIndex\": 0,\n \"targetId\": 449521285013368\n }\n ],\n \"updateTargetErrorResults\": []\n}" } ] }, { "name": "Get negative product target", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/negativeTargets/{{negativeTargetId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/negativeTargets/{{negativeTargetId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:23:34 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbnegativetarget.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "Q7RSH7FMP20FVYH0FHPA" }, { "key": "x-amz-request-id", "value": "Q7RSH7FMP20FVYH0FHPA" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"targetId\": 449521285013368,\n \"adGroupId\": 336526170361779,\n \"campaignId\": 373154468548682,\n \"state\": \"enabled\",\n \"expressions\": [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B07YT8NVF9\"\n }\n ],\n \"resolvedExpressions\": [\n {\n \"type\": \"asinSameAs\",\n \"value\": \"B07YT8NVF9\"\n }\n ]\n}" } ] }, { "name": "Delete negative product target", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/negativeTargets/{{negativeTargetId}}" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sb/negativeTargets/{{negativeTargetId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 15 Aug 2023 22:24:29 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbnegativetarget.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7MF20E90A0K2382ATXZF" }, { "key": "x-amz-request-id", "value": "7MF20E90A0K2382ATXZF" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"code\": \"SUCCESS\",\n \"targetId\": 449521285013368\n}" } ] }, { "name": "Get all categories", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/sb/targets/categories?supplySource=AMAZON", "host": [ "{{api_url}}" ], "path": [ "sb", "targets", "categories" ], "query": [ { "key": "supplySource", "value": "AMAZON" } ] } }, "response": [] }, { "name": "Get category refinements", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/targets/categories/{{categoryRefinementId}}/refinements", "description": "categoryRefinementId can be obtained by using the Get all categories request" }, "response": [] } ] }, { "name": "Ad creatives", "item": [ { "name": "Store spotlight", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbAdCreativeResource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adId\": \"{{adId}}\",\n \"creative\": {\n \"brandName\": \"My brand name\",\n \"subpages\": [\n {\n \"pageTitle\": \"Savannah\",\n \"asin\": \"B08MV395Y1\",\n \"url\": \"https://www.amazon.com/stores/page/2B2AE9C7-7EF4-4993-AA76-0FFF7EF7D050\"\n },\n {\n \"pageTitle\": \"Miami\",\n \"asin\": \"B08VGX1BXG\",\n \"url\": \"https://www.amazon.com/stores/page/E411CCC7-B125-4076-A476-197441A2A23E\"\n },\n {\n \"pageTitle\": \"San Fran\",\n \"asin\": \"B08VGYL7BM\",\n \"url\": \"https://www.amazon.com/stores/page/BE713C9E-F85F-4461-B42A-29740F5B61F5\"\n }\n ],\n \"consentToTranslate\": false,\n \"brandLogoAssetId\": \"amzn1.assetlibrary.asset1.XXXXXX\",\n \"headline\": \"Cheap pants\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/ads/creatives/storeSpotlight" }, "response": [] }, { "name": "Brand video", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbAdCreativeResource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adId\": \"{{adId}}\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxx\",\n \"brandName\": \"My brand\",\n \"headline\": \"My headline\",\n \"consentToTranslate\": false,\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxxx\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/ads/creatives/brandVideo" }, "response": [] }, { "name": "Product collection", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbAdCreativeResource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adId\": \"{{adId}}\",\n \"creative\": {\n \"asins\": [\n \"B00JVTNWB0\"\n ],\n \"brandLogoAssetID\": \"amzn1.assetlibrary.asset1.xxxxxxx\",\n \"brandName\": \"My brand\",\n \"headline\": \"My headline\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/ads/creatives/productCollection" }, "response": [] }, { "name": "Product collection Extended", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbAdCreativeResource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adId\": \"{{adId}}\",\n \"creative\": {\n \"asins\": [\n \"B0C81DZTX4\",\n \"B0C81CBH6K\",\n \"B0BTHXJ718\"\n ],\n \"brandLogoAssetId\": \"amzn1.assetlibrary.asset1.xxxxxx:version_v1\",\n \"brandLogoCrop\": {\n \"height\": 768,\n \"left\": 0,\n \"top\": 0,\n \"width\": 768\n },\n \"brandLogoUrl\": \"https://m.media-amazon.com/images/S/example.png\",\n \"brandName\": \"name of brand\",\n \"customImages\": [{\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxx:version_v1\",\n \"crop\": {\n \"height\": 628,\n \"left\": 0,\n \"top\": 0,\n \"width\": 1200\n },\n \"url\": \"https://m.media-amazon.com/images/S/example.png\"\n }],\n \"headline\": \"name of headline\",\n \"landingPage\": {\n \"type\": \"PRODUCT_LIST\",\n \"asins\": [\n \"B0C81DZTX4\",\n \"B0C81CBH6K\",\n \"B0BTHXJ718\"\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/ads/creatives/productCollectionExtended" }, "response": [] }, { "name": "Video", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbAdCreativeResource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adId\": \"{{adId}}\",\n \"creative\": {\n \"consentToTranslate\": false,\n \"videoAssetIds\": [\n \"amzn1.assetlibrary.asset1.xxxxxxxx\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/ads/creatives/video" }, "response": [] }, { "name": "List ad creatives", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbAdCreativeResource.v4+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adId\": \"{{adId}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sb/ads/creatives/list" }, "response": [] } ] }, { "name": "Get brands", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save brandEntityID for first object to environment*/", "if(responseCode.code === 200) {", "var brandEntityId = response.brandEntityId", "postman.clearEnvironmentVariable(\"brandEntityId\");", "postman.setEnvironmentVariable(\"brandEntityId\", brandEntityId);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.brand.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.batchgetcampaignsresponse.v3.3+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "" }, "url": "{{api_url}}/brands" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.brand.v3+json", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.batchgetcampaignsresponse.v3.3+json", "type": "default", "disabled": true } ], "url": "{{api_url}}/brands" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 30 Mar 2023 16:30:37 GMT" }, { "key": "Content-Type", "value": "application/vnd.brand.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "6Z5VDKFFBZ0M1CXJ7Y9J" }, { "key": "x-amz-request-id", "value": "6Z5VDKFFBZ0M1CXJ7Y9J" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"brandId\": \"AXXXXXXXXX\",\n \"brandEntityId\": \"ENTITYXXXXXXXXX\",\n \"brandRegistryName\": \"MYBRAND\"\n }\n]" } ] }, { "name": "Get landing page ASINS", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "", "value": "", "type": "default" }, { "key": "Accept", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/pageAsins?pageUrl=https://www.amazon.com/stores/page/XXXXXXXX", "host": [ "{{api_url}}" ], "path": [ "pageAsins" ], "query": [ { "key": "pageUrl", "value": "https://www.amazon.com/stores/page/XXXXXXXX" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "", "value": "", "type": "default" }, { "key": "Accept", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/pageAsins?pageUrl=https://www.amazon.com/stores/page/XXXXXXX", "host": [ "{{api_url}}" ], "path": [ "pageAsins" ], "query": [ { "key": "pageUrl", "value": "https://www.amazon.com/stores/page/XXXXXXX" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 30 Mar 2023 16:36:51 GMT" }, { "key": "Content-Type", "value": "application/vnd.pageasins.v3+json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "0GGBJAD8K8DKMGPNMD7X" }, { "key": "x-amz-request-id", "value": "0GGBJAD8K8DKMGPNMD7X" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"code\": \"SUCCESS\",\n \"asinList\": [\n \"B09XXXXXXS\",\n \"B09XXXXXXR\",\n \"B09XXXXXXY\",\n \"B09XXXXXXG\"\n ]\n}" } ] } ] }, { "name": "Sponsored Display", "item": [ { "name": "Campaigns", "item": [ { "name": "Create campaigns", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save campaignId for first object to environment*/", "", "var campaignId = response[0].campaignId;", "postman.clearEnvironmentVariable(\"campaignId\");", "postman.setEnvironmentVariable(\"campaignId\", campaignId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"Off-Amazon-Test-4\",\n \"budgetType\": \"daily\",\n \"budget\": \"10.00\",\n \"startDate\": \"20231010\",\n \"endDate\": \"20231101\",\n \"costType\": \"cpc\",\n \"state\": \"paused\",\n \"tactic\": \"T00030\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/campaigns", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Audience targeting (T00030)", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"test-campaign-1\",\n \"budgetType\": \"daily\",\n \"budget\": \"10.00\",\n \"startDate\": \"20231010\",\n \"endDate\": \"20231101\",\n \"costType\": \"cpc\",\n \"state\": \"paused\",\n \"tactic\": \"T00030\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/campaigns" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 13 Jul 2023 21:17:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "99KYKTTP91N1BNT4C3AN" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"campaignId\": 361249207815999,\n \"code\": \"SUCCESS\"\n }\n]" } ] }, { "name": "List campaigns", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save campaignId for first object to environment*/", "", "var campaignId = response[0].campaignId;", "postman.clearEnvironmentVariable(\"campaignId\");", "postman.setEnvironmentVariable(\"campaignId\", campaignId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/campaigns", "description": "brandEntityID is required for sellers" }, "response": [] } ] }, { "name": "Ad groups", "item": [ { "name": "Create ad groups", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adGroupId for first object to environment*/", "var adGroupId = response[0].adGroupId;", "postman.clearEnvironmentVariable(\"adGroupId\");", "postman.setEnvironmentVariable(\"adGroupId\", adGroupId);", "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"test-adgroup-1\",\n \"campaignId\": {{campaignId}},\n \"defaultBid\": 1,\n \"bidOptimization\": \"clicks\",\n \"state\": \"enabled\",\n \"creativeType\": \"IMAGE\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/adGroups", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"test-adgroup-1\",\n \"campaignId\": 123456789,\n \"defaultBid\": 1,\n \"bidOptimization\": \"clicks\",\n \"state\": \"enabled\",\n \"creativeType\": \"IMAGE\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/adGroups" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 13 Jul 2023 21:23:26 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ZNP46YA7H9GCAQF9GS46" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"adGroupId\": 510480088424692\n }\n]" } ] }, { "name": "Get ad groups", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adGroupId for first object to environment*/", "var adGroupId = response[0].adGroupId;", "postman.clearEnvironmentVariable(\"adGroupId\");", "postman.setEnvironmentVariable(\"adGroupId\", adGroupId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/adGroups", "description": "brandEntityID is required for sellers" }, "response": [] } ] }, { "name": "Product ads", "item": [ { "name": "Create product ads", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "var adId = response[0].adId;", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"campaignId\": {{campaignId}},\n \"landingPageURL\": \"https://www.myurl.com\",\n \"landingPageType\": \"OFF_AMAZON_LINK\",\n \"state\": \"enabled\",\n \"adName\": \"My ad\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/productAds", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Off-Amazon ad", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": 1234567890,\n \"campaignId\": 10987654321,\n \"landingPageURL\": \"https://www.myurl.com\",\n \"landingPageType\": \"OFF_AMAZON_LINK\",\n \"state\": \"enabled\",\n \"adName\": \"My ad\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/productAds" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 17 Jul 2023 18:06:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JV8J81YW47ESH3AY9WJ9" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"adId\": 538691658400674\n }\n]" } ] }, { "name": "Get product ads", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save adId for first object to environment*/", "var adId = response[0].adId;", "postman.clearEnvironmentVariable(\"adId\");", "postman.setEnvironmentVariable(\"adId\", adId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/productAds", "description": "brandEntityID is required for sellers" }, "response": [] } ] }, { "name": "Targeting", "item": [ { "name": "Create targets", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save targetId for first object to environment*/", "var targetId = response[0].targetId;", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expression\": [\n {\n \"type\": \"audience\",\n \"value\": [\n {\n \"type\": \"audienceSameAs\",\n \"value\": \"370208451989309147\"\n }\n ]\n }\n ],\n \"bid\": \"1.25\",\n \"adGroupId\": {{adGroupId}},\n \"expressionType\": \"manual\",\n \"state\": \"enabled\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/targets", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Audience", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expression\": [\n {\n \"type\": \"audience\",\n \"value\": [\n {\n \"type\": \"audienceSameAs\",\n \"value\": \"370208451989309147\"\n }\n ]\n }\n ],\n \"bid\": \"1.25\",\n \"adGroupId\": {{adGroupId}},\n \"expressionType\": \"manual\",\n \"state\": \"enabled\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/targets" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 17 Jul 2023 18:26:06 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "8415HNMD4MBM5KPYEQ70" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"description\": \"Estimated audience size: 4.5MM - 5MM\",\n \"targetId\": 527772488260916\n }\n]" } ] }, { "name": "Get targets", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save targetId for first object to environment*/", "var targetId = response[0].targetId;", "postman.clearEnvironmentVariable(\"targetId\");", "postman.setEnvironmentVariable(\"targetId\", targetId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/targets", "description": "brandEntityID is required for sellers" }, "response": [] }, { "name": "Audience taxonomy", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adType\": \"SD\",\n \"categoryPath\": [\"In-market\"]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/audiences/taxonomy/list", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adType\": \"SD\",\n \"categoryPath\": []\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/audiences/taxonomy/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 17 Jul 2023 18:14:23 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "213" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "4DVNN0ZC256RMEZ9S8CC" }, { "key": "x-amzn-RequestId", "value": "34c0a69e-61fe-446c-afe9-a2a5b2eae337" }, { "key": "x-amz-apigw-id", "value": "IOG38FhzIAMFsDg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64b584ff-c07ee477de6a83041ea53ede" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"categoryPath\": [],\n \"categories\": [\n {\n \"category\": \"In-market\",\n \"audienceCount\": 6236\n },\n {\n \"category\": \"Interest\",\n \"audienceCount\": 968\n },\n {\n \"category\": \"Lifestyle\",\n \"audienceCount\": 672\n },\n {\n \"category\": \"Life event\",\n \"audienceCount\": 8\n }\n ]\n}" } ] }, { "name": "Audience discovery", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adType\": \"SD\",\n \"filters\": [\n {\n \"field\": \"categoryPath\",\n \"values\": [\n \"In-market\"\n ]\n },\n {\n \"field\": \"audienceName\",\n \"values\": [\n \"*\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/audiences/list", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adType\": \"SD\",\n \"filters\": [\n {\n \"field\": \"categoryPath\",\n \"values\": [\n \"In-market\"\n ]\n },\n {\n \"field\": \"audienceName\",\n \"values\": [\n \"*\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/audiences/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 17 Jul 2023 18:18:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "25727" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "GE5KZFTZ609ABA4JE408" }, { "key": "x-amzn-RequestId", "value": "c676c798-10f8-457b-8b80-65404ed7af3e" }, { "key": "x-amz-apigw-id", "value": "IOHeLEqNIAMFmVg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64b585f4-2b2d75d59d84ce8a94b78281" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"audiences\": [\n {\n \"audienceId\": \"370208451989309147\",\n \"audienceName\": \"IM - Off-Amazon Nail Polish Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop nail polish products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-22T09:12:30.534Z\",\n \"updateDate\": \"2023-04-17T04:39:14.834Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2000000,\n \"upperBoundExclusive\": 2500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"422525420928672195\",\n \"audienceName\": \"IM - Off-Amazon Cat Food Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Cat Food Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-09-08T21:17:16.240Z\",\n \"updateDate\": \"2023-04-17T07:20:22.862Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3000000,\n \"upperBoundExclusive\": 3500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"371622057943434872\",\n \"audienceName\": \"IM - Off-Amazon Men's Shoes Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Men's Shoes Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:08:39.448Z\",\n \"updateDate\": \"2023-04-17T08:57:51.052Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 7000000,\n \"upperBoundExclusive\": 8000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"363444722732945841\",\n \"audienceName\": \"IM - Off Amazon Womens Tops, Tees & Blouses Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop womens tops, tees & blouses- Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-08T09:29:53.394Z\",\n \"updateDate\": \"2023-04-17T10:09:26.851Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 5000000,\n \"upperBoundExclusive\": 6000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"406787621652464743\",\n \"audienceName\": \"IM - Off-Amazon Baking Tools & Accessories Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Baking Tools & Accessories Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:13:15.867Z\",\n \"updateDate\": \"2023-04-17T04:43:44.005Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3000000,\n \"upperBoundExclusive\": 3500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"423026853221779920\",\n \"audienceName\": \"IM - Off-Amazon Chips & Crisps Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop chips & crisps products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-31T14:14:08.118Z\",\n \"updateDate\": \"2023-05-05T12:27:21.845Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1500000,\n \"upperBoundExclusive\": 2000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"363554659630454476\",\n \"audienceName\": \"IM - Off-Amazon Stuffed Animals & Plush Toys Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Stuffed Animals & Plush Toys Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-11-21T16:48:31.378Z\",\n \"updateDate\": \"2023-04-17T07:23:07.109Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 4500000,\n \"upperBoundExclusive\": 5000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"365921606591106231\",\n \"audienceName\": \"IM - Off-Amazon Breads & Bakery Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop breads & bakery products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-24T15:28:09.381Z\",\n \"updateDate\": \"2023-05-09T19:21:01.555Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3500000,\n \"upperBoundExclusive\": 4000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"381838682832671118\",\n \"audienceName\": \"IM - Off-Amazon Sport Specific Clothing Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Sport Specific Clothing Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:00:17.947Z\",\n \"updateDate\": \"2023-04-17T06:07:46.642Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 5000000,\n \"upperBoundExclusive\": 6000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"378056944086897893\",\n \"audienceName\": \"IM - Off-Amazon Baby Clothes, Shoes & Jewlery Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Baby Clothes, Shoes & Jewlery Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-01T09:24:16.247Z\",\n \"updateDate\": \"2023-06-24T17:52:37.937Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 5000000,\n \"upperBoundExclusive\": 6000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"367553436757816547\",\n \"audienceName\": \"IM - Off-Amazon Creams & Moisturizers Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Creams & Moisturizers Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-06T17:36:53.413Z\",\n \"updateDate\": \"2023-04-17T15:53:30.911Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3500000,\n \"upperBoundExclusive\": 4000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"428887410821646975\",\n \"audienceName\": \"IM - Off-Amazon Multivitamins Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Multivitamins Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-06T17:29:37.685Z\",\n \"updateDate\": \"2023-04-17T07:23:25.634Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3000000,\n \"upperBoundExclusive\": 3500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"410897008144634449\",\n \"audienceName\": \"IM - Off-Amazon Coffee/Coffee Product Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Coffee/Coffee Product Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-09-09T14:12:22.530Z\",\n \"updateDate\": \"2023-04-17T15:52:42.878Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 6000000,\n \"upperBoundExclusive\": 7000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"380676799746441277\",\n \"audienceName\": \"IM - Off-Amazon Fragrance Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Fragrance Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-11-21T16:40:44.249Z\",\n \"updateDate\": \"2023-04-17T08:31:46.525Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2500000,\n \"upperBoundExclusive\": 3000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"387775763799759615\",\n \"audienceName\": \"IM - Off-Amazon Dolls Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Dolls Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-01T09:16:06.997Z\",\n \"updateDate\": \"2023-04-17T15:52:31.975Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1500000,\n \"upperBoundExclusive\": 2000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"419499037829697646\",\n \"audienceName\": \"IM - Off-Amazon Dog Treats Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Dog Treats Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-23T14:19:44.975Z\",\n \"updateDate\": \"2023-04-17T04:39:13.999Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 6000000,\n \"upperBoundExclusive\": 7000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"409827680095158132\",\n \"audienceName\": \"IM - Off-Amazon Video Game Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Video Game Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-06T17:39:30.668Z\",\n \"updateDate\": \"2023-04-17T05:27:29.378Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3500000,\n \"upperBoundExclusive\": 4000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"424437997240241413\",\n \"audienceName\": \"IM - Off-Amazon Cooking & Baking Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Cooking & Baking Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-13T12:52:07.330Z\",\n \"updateDate\": \"2023-04-17T05:15:10.651Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 6000000,\n \"upperBoundExclusive\": 7000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"363398204086941416\",\n \"audienceName\": \"IM - Off-Amazon Bath Accessories Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Bath Accessories Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-23T14:23:30.846Z\",\n \"updateDate\": \"2023-04-17T05:27:29.919Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2500000,\n \"upperBoundExclusive\": 3000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"368368172300811321\",\n \"audienceName\": \"IM - Off Amazon Mouthwash Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop mouthwash products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-10T10:57:44.441Z\",\n \"updateDate\": \"2023-04-17T15:54:20.029Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2000000,\n \"upperBoundExclusive\": 2500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"400084644640013530\",\n \"audienceName\": \"IM - Off-Amazon Womens Jeans Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Womens Jeans Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-26T14:17:47.919Z\",\n \"updateDate\": \"2023-04-17T09:10:55.077Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2500000,\n \"upperBoundExclusive\": 3000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"377065750794216518\",\n \"audienceName\": \"IM - Off-Amazon Action Figures Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Action Figures Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-01T09:12:51.021Z\",\n \"updateDate\": \"2023-04-17T08:09:28.517Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3500000,\n \"upperBoundExclusive\": 4000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"361097856378222489\",\n \"audienceName\": \"IM - Off-Amazon Candy & Chocolate Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Candy & Chocolate Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-12T18:34:37.614Z\",\n \"updateDate\": \"2023-04-17T08:06:03.755Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 6000000,\n \"upperBoundExclusive\": 7000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"410736468479799899\",\n \"audienceName\": \"IM - Off-Amazon Frozen Meals & Entrees Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Frozen Meals & Entrees Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:06:03.447Z\",\n \"updateDate\": \"2023-04-17T05:22:32.684Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3500000,\n \"upperBoundExclusive\": 4000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"378111840300279090\",\n \"audienceName\": \"IM - Financial Services\",\n \"description\": \"People who use apps related to Finance on Fire Tablet\",\n \"category\": \"In-market\",\n \"createDate\": \"2017-08-29T18:34:42.727Z\",\n \"updateDate\": \"2023-03-28T10:53:46.929Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 80000,\n \"upperBoundExclusive\": 90000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"408766101482993546\",\n \"audienceName\": \"IM - Off Amazon Diaper Wipes & Holders Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop diaper wipes & holders - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-23T11:34:50.917Z\",\n \"updateDate\": \"2023-04-17T04:39:13.246Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2000000,\n \"upperBoundExclusive\": 2500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"413017137524785359\",\n \"audienceName\": \"IM - Off-Amazon Skin Care Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Skin Care Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-11-25T11:05:27.166Z\",\n \"updateDate\": \"2023-04-17T05:15:15.020Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 9000000,\n \"upperBoundExclusive\": 10000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"430501340540733716\",\n \"audienceName\": \"IM - Business Shoppers - BISS \",\n \"description\": \" Customers who exhibit purchasing behaviour similar to those with Amazon Business accounts.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-17T15:23:22.200Z\",\n \"updateDate\": \"2023-01-17T15:39:54.311Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 100000,\n \"upperBoundExclusive\": 150000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"378115464992189883\",\n \"audienceName\": \"IM - Off-Amazon Mineral Water Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop mineral water products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-22T08:59:14.530Z\",\n \"updateDate\": \"2023-04-17T07:24:45.746Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1000000,\n \"upperBoundExclusive\": 1500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"410560969471178661\",\n \"audienceName\": \"IM - Off-Amazon Protein Bars Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop protein bars products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-22T09:07:54.989Z\",\n \"updateDate\": \"2023-04-17T04:39:10.725Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2500000,\n \"upperBoundExclusive\": 3000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"407158297315137866\",\n \"audienceName\": \"IM - Off-Amazon Dolls & Accessories Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Dolls & Accessories Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-11-21T16:46:29.621Z\",\n \"updateDate\": \"2023-04-17T05:22:29.565Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 5000000,\n \"upperBoundExclusive\": 6000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"417077341456261572\",\n \"audienceName\": \"IM - Off-Amazon Probiotics Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Probiotics Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-01T09:32:16.525Z\",\n \"updateDate\": \"2023-04-17T05:22:35.858Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 4000000,\n \"upperBoundExclusive\": 4500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"382679652378387105\",\n \"audienceName\": \"IM - Off Amazon Snack Bars Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop snack bars - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-16T17:24:14.173Z\",\n \"updateDate\": \"2023-04-17T05:15:11.904Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2500000,\n \"upperBoundExclusive\": 3000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"368582925015727908\",\n \"audienceName\": \"IM - Off-Amazon Facial Tissues Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop facial tissue products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-23T11:42:47.733Z\",\n \"updateDate\": \"2023-04-17T05:27:30.697Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1000000,\n \"upperBoundExclusive\": 1500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"363276719870120161\",\n \"audienceName\": \"IM - Off-Amazon Cat Treats Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Cat Treats Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-23T14:21:39.661Z\",\n \"updateDate\": \"2023-05-03T21:09:55.203Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1000000,\n \"upperBoundExclusive\": 1500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"420080217834842977\",\n \"audienceName\": \"IM - Off-Amazon Disposable Diapers Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Disposable Diapers Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-01-17T16:32:15.062Z\",\n \"updateDate\": \"2023-04-17T07:43:29.984Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3000000,\n \"upperBoundExclusive\": 3500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"372843524184795098\",\n \"audienceName\": \"IM - Off-Amazon Iced Tea Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop iced tea products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-03-23T11:41:00.634Z\",\n \"updateDate\": \"2023-04-16T22:44:58.849Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 800000,\n \"upperBoundExclusive\": 900000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"402540857203459227\",\n \"audienceName\": \"IM - Off-Amazon Amazon Camera, Photo and Video Accessories Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Amazon Camera, Photo and Video Accessories Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-06T17:31:10.786Z\",\n \"updateDate\": \"2023-04-17T08:06:04.109Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2000000,\n \"upperBoundExclusive\": 2500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"411385783262868222\",\n \"audienceName\": \"IM - Off-Amazon Styling Products Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Styling Products Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:07:40.534Z\",\n \"updateDate\": \"2023-04-17T08:31:49.388Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 4500000,\n \"upperBoundExclusive\": 5000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"387426467697012473\",\n \"audienceName\": \"IM - Off Amazon Boys Clothing Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop boys clothing - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-15T09:15:59.981Z\",\n \"updateDate\": \"2023-04-17T09:10:53.558Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3500000,\n \"upperBoundExclusive\": 4000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"390356410476971186\",\n \"audienceName\": \"IM - Off Amazon Antioxidants Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop antioxidants - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-08T10:36:19.026Z\",\n \"updateDate\": \"2023-04-17T05:15:10.317Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1500000,\n \"upperBoundExclusive\": 2000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"370913498296837792\",\n \"audienceName\": \"IM - Off-Amazon Greeting Cards Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Greeting Cards Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-13T17:31:08.322Z\",\n \"updateDate\": \"2023-04-17T05:27:29.662Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2500000,\n \"upperBoundExclusive\": 3000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"406558287865637089\",\n \"audienceName\": \"IM - Off-Amazon Toy Figures & Playsets Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Toy Figures & Playsets Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-11-21T16:44:20.008Z\",\n \"updateDate\": \"2023-04-17T05:22:34.031Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 3000000,\n \"upperBoundExclusive\": 3500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"392347874148224062\",\n \"audienceName\": \"IM - Off-Amazon Nutrition Bars & Drinks Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop nutrition bars & drinks - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-24T13:56:41.966Z\",\n \"updateDate\": \"2023-04-17T04:43:46.942Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2000000,\n \"upperBoundExclusive\": 2500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"423539876137820239\",\n \"audienceName\": \"IM - Off-Amazon Plush Figures Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop plush figures products - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-24T15:30:05.614Z\",\n \"updateDate\": \"2023-04-17T04:43:46.368Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 2000000,\n \"upperBoundExclusive\": 2500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"412827258347610760\",\n \"audienceName\": \"IM - Off Amazon Hair Sprays Shoppers\",\n \"description\": \"Lookalike Audiences based on people whose off-Amazon shopping activities indicate that they shop hair sprays - Powered by Amazon Shopper Panel.\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-08T09:32:31.696Z\",\n \"updateDate\": \"2023-04-17T12:48:10.117Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 4000000,\n \"upperBoundExclusive\": 4500000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"379578597240077407\",\n \"audienceName\": \"IM - Off-Amazon Personal Cleansing Wipes Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Personal Cleansing Wipes Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-02-01T09:40:15.684Z\",\n \"updateDate\": \"2023-04-17T08:09:24.303Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1500000,\n \"upperBoundExclusive\": 2000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"396323902175655491\",\n \"audienceName\": \"IM - Auto Intender\",\n \"description\": \"Auto intenders for US market based on propensity model\",\n \"category\": \"In-market\",\n \"createDate\": \"2023-07-06T10:12:25.459Z\",\n \"updateDate\": \"2023-07-06T10:12:56.048Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {}\n }\n },\n {\n \"audienceId\": \"400681955407785615\",\n \"audienceName\": \"IM - Off-Amazon Team Sports Equipments Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Team Sports Equipments Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:12:03.504Z\",\n \"updateDate\": \"2023-04-17T04:39:13.512Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 4500000,\n \"upperBoundExclusive\": 5000000\n }\n }\n }\n }\n },\n {\n \"audienceId\": \"410487260666979393\",\n \"audienceName\": \"IM - Off-Amazon Automotive Oils & Fluids Shoppers\",\n \"description\": \"Lookalikes of people whose shopping activity indicates that they are Off-Amazon Automotive Oils & Fluids Shoppers. Powered by Amazon Shopper Panel (https://panel.amazon.com/)\",\n \"category\": \"In-market\",\n \"createDate\": \"2022-12-14T17:14:22.003Z\",\n \"updateDate\": \"2023-04-17T05:22:31.859Z\",\n \"status\": \"Active\",\n \"forecasts\": {\n \"inventoryForecasts\": {\n \"all\": {\n \"dailyReach\": {\n \"lowerBoundInclusive\": 1500000,\n \"upperBoundExclusive\": 2000000\n }\n }\n }\n }\n }\n ],\n \"matchCount\": 100,\n \"nextToken\": \"nLjqaQ0Q2INb0zXe1pwhlIpVInxEkIIGFcYGe35W607l4ui_TmcbYJBKrVf1Ezgaqg6_keKcKlfCBuN_raETnj0k70RkLaTAlSzthW1LOQhkm4YBluoTz7MjXYEJjFWUQeu4RYVU5GIISdzo2bg2_EzQIBA9D0h8H6j4BwdA6STJH4qkkgDgay6NVJyy_uUnvB5wVyOd71eO9SnIOuql6F3m1q0fTxrlqS0kqDLhPDtvpEkTHuSv8vSpK3E9P1W1wz3Y-grJgO0FOdpK-c2iZ31JssPph7maJH4u\"\n}" } ] } ] }, { "name": "Creatives", "item": [ { "name": "Add creatives", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save creativeId for first object to environment*/", "var creativeId = response[0].creativeId;", "postman.clearEnvironmentVariable(\"creativeId\");", "postman.setEnvironmentVariable(\"creativeId\", creativeId);" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text", "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account." }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text", "description": "(Required) The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header." }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"properties\": {\n \"headline\": \"Test_Headline\",\n \"brandLogo\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.b5a289e461ea715400e0b91948fdb074\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 600,\n \"height\": 100\n }\n },\n \"contentType\": \"CUSTOM_IMAGE\",\n \"rectCustomImage\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.2521ca7dcfdeb3f98bca7447d64ae797\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 628\n }\n },\n \"squareCustomImage\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.2521ca7dcfdeb3f98bca7447d64ae797\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 628,\n \"height\": 628\n }\n }\n }\n }\n]" }, "url": "{{api_url}}/sd/creatives", "description": "**Note that this operation is not currently supported. This note will be removed when this operation is available.** Creates one or more creatives." }, "response": [ { "name": "Custom image, logo, and headline", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text", "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account." }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text", "description": "(Required) The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header." }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"properties\": {\n \"headline\": \"Test_Headline\",\n \"brandLogo\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxxx1\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 600,\n \"height\": 100\n }\n },\n \"contentType\": \"CUSTOM_IMAGE\",\n \"rectCustomImage\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxxxxx2\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 628\n }\n },\n \"squareCustomImage\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxxxxxx2\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 628,\n \"height\": 628\n }\n }\n }\n }\n]" }, "url": "{{api_url}}/sd/creatives" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 18 Jul 2023 16:17:17 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "52" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "DCMVCAWHCW6TNPQSRA6S" }, { "key": "x-amzn-RequestId", "value": "ad96bc5f-6431-4be4-8b63-7cba2530127b" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "DCMVCAWHCW6TNPQSRA6S" }, { "key": "x-amzn-Remapped-Content-Length", "value": "52" }, { "key": "x-amzn-Remapped-Connection", "value": "keep-alive" }, { "key": "x-amz-apigw-id", "value": "IRIqFHLXIAMFmYw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64b6bb0d-4d2cad003cfe8e820eb82296" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 18 Jul 2023 16:17:17 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"creativeId\": 873112658567083590,\n \"code\": \"SUCCESS\"\n }\n]" } ] }, { "name": "List creatives", "event": [ { "listen": "test", "script": { "exec": [ "var response = JSON.parse(responseBody);", "", "/*Save creativeId for first object to environment*/", "var creativeId = response[0].creativeId;", "postman.clearEnvironmentVariable(\"creativeId\");", "postman.setEnvironmentVariable(\"creativeId\", creativeId);" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text", "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account." }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text", "description": "(Required) The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header." }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{api_url}}/sd/creatives?adGroupIdFilter={{adGroupId}}", "host": [ "{{api_url}}" ], "path": [ "sd", "creatives" ], "query": [ { "key": "adGroupIdFilter", "value": "{{adGroupId}}" } ] }, "description": "**Note that this operation is not currently supported. This note will be removed when this operation is available.** Creates one or more creatives." }, "response": [] }, { "name": "Update creatives", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text", "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account." }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text", "description": "(Required) The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header." }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"properties\": {\n \"headline\": \"Test_Headline\",\n \"brandLogo\": {\n \"assetId\": \"{{assetId}}\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 600,\n \"height\": 100\n }\n },\n \"contentType\": \"CUSTOM_IMAGE\",\n \"rectCustomImage\": {\n \"assetId\": \"{{assetId}}\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 628\n }\n },\n \"squareCustomImage\": {\n \"assetId\": \"{{assetId}}\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 628,\n \"height\": 628\n }\n }\n \n },\n \"creativeId\": 880210367106070471\n }\n]\n\n\n\n" }, "url": "{{api_url}}/sd/creatives", "description": "**Note that this operation is not currently supported. This note will be removed when this operation is available.** Creates one or more creatives." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text", "description": "(Required) The identifier of a client associated with a \"Login with Amazon\" account." }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text", "description": "(Required) The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header." }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"properties\": {\n \"headline\": \"Test_Headline\",\n \"brandLogo\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxxx1\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 600,\n \"height\": 100\n }\n },\n \"contentType\": \"CUSTOM_IMAGE\",\n \"rectCustomImage\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxxxx2\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 1200,\n \"height\": 628\n }\n },\n \"squareCustomImage\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxxxxxx2\",\n \"assetVersion\": \"version_v1\",\n \"croppingCoordinates\": {\n \"top\": 0,\n \"left\": 0,\n \"width\": 628,\n \"height\": 628\n }\n }\n \n },\n \"creativeId\": 880210367106070471\n }\n]\n\n\n\n" }, "url": "{{api_url}}/sd/creatives" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 18 Jul 2023 16:14:05 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "52" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "6CHE21XDRWJR9883QDGM" }, { "key": "x-amzn-RequestId", "value": "f686ccf4-9a80-417a-907e-4c6ef74cdefb" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "6CHE21XDRWJR9883QDGM" }, { "key": "x-amzn-Remapped-Content-Length", "value": "52" }, { "key": "x-amzn-Remapped-Connection", "value": "keep-alive" }, { "key": "x-amz-apigw-id", "value": "IRIMIFWJIAMFU1g=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64b6ba4d-7c7b7afcd75c666a3204bf8d" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 18 Jul 2023 16:14:05 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"creativeId\": 880210367106070471,\n \"code\": \"SUCCESS\"\n }\n]" } ] } ] }, { "name": "Locations", "item": [ { "name": "Locations", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"expressionType\": \"manual\",\n \"state\": \"enabled\",\n \"expression\": [\n {\n \"type\": \"location\",\n \"value\": \"amzn1.ad-geo.GP-US-10005\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/locations", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "[\n {\n \"adGroupId\": {{adGroupId}},\n \"expressionType\": \"manual\",\n \"state\": \"enabled\",\n \"expression\": [\n {\n \"type\": \"location\",\n \"value\": \"amzn1.ad-geo.GP-US-10005\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/sd/locations" }, "status": "Multi-Status", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 19 Jul 2023 20:40:13 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "4RND2VT8N42JM1YF7237" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"locationExpressionId\": 303747983880114\n }\n]" } ] }, { "name": "Locations", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/locations", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/sd/locations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 19 Jul 2023 20:40:29 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "9N2JMHNWZ5B3NZS1W9P6" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"adGroupId\": 413803530857698,\n \"expression\": [\n {\n \"type\": \"location\",\n \"value\": \"amzn1.ad-geo.GP-US-10005\"\n }\n ],\n \"expressionType\": \"manual\",\n \"resolvedExpression\": [\n {\n \"type\": \"location\",\n \"value\": \"New York, New York, US - 10005\"\n }\n ],\n \"state\": \"enabled\",\n \"locationExpressionId\": 303747983880114\n }\n]" } ] } ] } ] }, { "name": "Stores", "item": [ { "name": "Get stores", "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/v2/stores" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "url": "{{api_url}}/v2/stores" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 30 Mar 2023 16:31:36 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "6CWXYZ2NXT0XKXC7MD03" }, { "key": "x-amz-request-id", "value": "6CWXYZ2NXT0XKXC7MD03" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "[\n {\n \"code\": \"SUCCESS\",\n \"entityId\": \"ENTITYXXXXXXX\",\n \"storeName\": \"Test Brand Seller\",\n \"storePageInfo\": [\n {\n \"storePageId\": \"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXX\",\n \"storePageUrl\": \"https://www.amazon.com/stores/page/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXX\",\n \"storePageName\": \"Home\"\n }\n ],\n \"brandEntityId\": \"ENTITYXXXXXXX\"\n }\n]" } ] }, { "name": "Insight metrics", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"startDate\": \"YYYY-MM-DD\",\n \"endDate\": \"YYYY-MM-DD\",\n \"dimension\": \"DATE\",\n \"maxResult\": 1000,\n \"metrics\": [\n \"SCORE_LEVEL\",\n \"RECOMMENDATIONS\",\n \"CONTRIBUTORS\",\n \"DWELL\",\n \"PEER_DWELL\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/stores/{{brandEntityId}}/insights" }, "response": [] } ] }, { "name": "Product metadata", "item": [ { "name": "Get product metadata", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"asins\": [\n \"B0B9VJLZ69\"\n ],\n \"adType\": \"SP\",\n \"pageSize\": 5,\n \"pageIndex\": 0\n}" }, "url": "{{api_url}}/product/metadata" }, "response": [] }, { "name": "Get product eligibility", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Prefer", "value": "return=representation", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adType\": \"sp\",\n \"productDetailsList\": [\n {\n \"asin\": \"B0B9VJLZ69\"\n }\n ]\n}" }, "url": "{{api_url}}/eligibility/product/list" }, "response": [] } ] }, { "name": "Budget rules", "item": [ { "name": "SP", "item": [ { "name": "Create budget rules", "event": [ { "listen": "test", "script": { "exec": [ "/* Save ruleId to environment */", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var budgetRuleId = response.responses[0].ruleId", "postman.clearEnvironmentVariable(\"budgetRuleId\");", "postman.setEnvironmentVariable(\"budgetRuleId\", budgetRuleId); ", " console.log(\"ruleId is \" + budgetRuleId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"ACOS < 20%\",\n \"ruleType\": \"PERFORMANCE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ACOS\",\n \"threshold\": 20,\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\"\n }\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "response": [ { "name": "Event-based, scheduled, daily rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"Easter 25%\",\n \"ruleType\": \"SCHEDULE\",\n \"duration\": {\n \"eventTypeRuleDuration\": {\n \"eventId\": \"{{eventId}}\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n }\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 18:25:06 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7FGJM8PBRGWBHHCJ9A7V" }, { "key": "x-amzn-RequestId", "value": "8adfba60-8de4-4d88-a4e8-ad169fd0a0fc" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "7FGJM8PBRGWBHHCJ9A7V" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 18:25:06 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "ApoodEAloAMFrqQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3bb02-effc633ece845ea3d401b5cd" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 18:25:06 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"98ef675d-e436-4506-85c9-c60345318e08\"\n }\n ]\n}" }, { "name": "Scheduled, weekly rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"Spring 35%\",\n \"ruleType\": \"SCHEDULE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"WEEKLY\",\n \"daysOfWeek\": [\n \"MONDAY\",\"WEDNESDAY\"\n ]\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 35\n }\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 18:34:20 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "9T4SW0E2N8HP8YASBQN6" }, { "key": "x-amzn-RequestId", "value": "0902e47f-7d07-4ea4-9aac-ab175c3cf6f7" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "9T4SW0E2N8HP8YASBQN6" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 18:34:20 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "App-_F-HoAMFYkA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3bd2c-0cc919fd3e03c873f606f4c1" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 18:34:20 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"30db13f7-360e-475e-ae76-f779c2303749\"\n }\n ]\n}" }, { "name": "Performance-based rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"ACOS < 20%\",\n \"ruleType\": \"PERFORMANCE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ACOS\",\n \"threshold\": 20,\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\"\n }\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 18:41:18 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "34B53KRFCZJA04N33BH4" }, { "key": "x-amzn-RequestId", "value": "1f22d6bc-5a37-43c3-b886-30ac906a50ee" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "34B53KRFCZJA04N33BH4" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 18:41:18 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "AprARGXpoAMFWmA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3bece-6b5201a37d924b1f972b285e" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 18:41:17 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"22cbf410-cab5-434c-bc79-540e0ed8e90c\"\n }\n ]\n}" } ] }, { "name": "Associate budget rules to campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\n \"{{budgetRuleId}}\"\n ]\n}" }, "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\n \"{{budgetRuleId}}\"\n ]\n}" }, "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:18:21 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "113" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "1FC9NEW0WKK67QKQZ90P" }, { "key": "x-amzn-RequestId", "value": "bda2830f-a740-4df8-a914-4d0af68b225a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "1FC9NEW0WKK67QKQZ90P" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:18:21 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "113" }, { "key": "x-amz-apigw-id", "value": "Aq2vmHXcIAMFe5w=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f437fd-b5b56a323078a7fed94b5976" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:18:21 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"code\": \"Ok\",\n \"details\": \"Budget rule associated\",\n \"ruleId\": \"9b320ccc-6f06-4662-a86d-2fab422ccee8\"\n }\n ]\n}" } ] }, { "name": "Get recommended events", "event": [ { "listen": "test", "script": { "exec": [ "/*Save eventId from first object to environment*/", "", "if (responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " if(!response.recommendedBudgetRuleEvents[0]) {", " console.info(\"No events were returned.\");", " } else {", " var eventId = response.recommendedBudgetRuleEvents[0].eventId", " postman.clearEnvironmentVariable(\"eventId\");", " postman.setEnvironmentVariable(\"eventId\", eventId); ", " console.log(\"eventId from first event object is \" + eventId);", " } ", "} else {", " console.log(responseCode, responseBody);", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spbudgetrulesrecommendation.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignId\":\"{{campaignId}}\"\n}" }, "url": "{{api_url}}/sp/campaigns/budgetRules/recommendations" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spbudgetrulesrecommendation.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignId\":\"{{campaignId}}\"\n}" }, "url": { "raw": "{{api_url}}/sp/campaigns/budgetRules/recommendations", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", "budgetRules", "recommendations" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 18:15:49 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "500" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CN4N80ZRHE4ZN883X8H2" }, { "key": "x-amzn-RequestId", "value": "67e7c628-a00d-4a82-bfb9-8ed645b0812c" }, { "key": "x-amz-apigw-id", "value": "ApnRRHThIAMFe0A=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3b8d5-abcf439923d38a1c6bd9579c" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"recommendedBudgetRuleEvents\": [\n {\n \"endDate\": \"20230409\",\n \"eventId\": \"c92869a2-fe6f-56ac-ba86-d08388396936\",\n \"eventName\": \"Easter\",\n \"startDate\": \"20230326\",\n \"suggestedBudgetIncreasePercent\": 24\n },\n {\n \"endDate\": \"20230515\",\n \"eventId\": \"1b943597-d48e-5147-abd1-7ed20fcb693c\",\n \"eventName\": \"Mother's Day\",\n \"startDate\": \"20230511\",\n \"suggestedBudgetIncreasePercent\": 0\n },\n {\n \"endDate\": \"20230619\",\n \"eventId\": \"553ddee0-8178-544b-a54a-f8918d21ad5f\",\n \"eventName\": \"Father's Day\",\n \"startDate\": \"20230611\",\n \"suggestedBudgetIncreasePercent\": 38\n }\n ]\n}" } ] }, { "name": "All budget rules", "event": [ { "listen": "test", "script": { "exec": [ "/*Save budgetRuleId from first object to environment*/", "", "if (responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " if(!response.budgetRulesForAdvertiserResponse[0]) {", " console.info(\"No rules were returned.\");", " } else {", " var budgetRuleId = response.budgetRulesForAdvertiserResponse[0].ruleId", " postman.clearEnvironmentVariable(\"budgetRuleId\");", " postman.setEnvironmentVariable(\"budgetRuleId\", budgetRuleId); ", " console.log(\"budgetRuleId from first rule object is \" + budgetRuleId);", " } ", "} else {", " console.log(responseCode, responseBody);", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sp/budgetRules?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true }, { "key": "pageSize", "value": "30" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sp/budgetRules?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true }, { "key": "pageSize", "value": "30" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 16:56:49 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1265" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "QPZYFNZADFJ36J42XPYZ" }, { "key": "x-amzn-RequestId", "value": "6d3c5945-b8a5-4c0a-b31d-f85609b4ae4a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "QPZYFNZADFJ36J42XPYZ" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 16:56:49 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1265" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "ApbssFA_IAMFV0w=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3a651-107b2df163d3c25a450a8db7" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 16:56:49 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"budgetRulesForAdvertiserResponse\": [\n {\n \"createdDate\": 1676912194576,\n \"lastUpdatedDate\": 1676912194576,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230228\",\n \"startDate\": \"20230220\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring Budget Rule\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 2\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"f1eded08-af77-454a-b307-7783802657e2\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n },\n {\n \"createdDate\": 1676912153402,\n \"lastUpdatedDate\": 1676912153402,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": null,\n \"eventTypeRuleDuration\": {\n \"endDate\": \"20230515\",\n \"eventId\": \"1b943597-d48e-5147-abd1-7ed20fcb693c\",\n \"eventName\": \"Mother's Day\",\n \"startDate\": \"20230511\"\n }\n },\n \"name\": \"Mother's Day Budget Rule\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"c29298a0-0369-4146-8065-a73d33d51779\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": null\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Update budget rules", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"ruleType\": \"PERFORMANCE\",\n \"name\": \"Spring Budget Rule - Updated\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230220\",\n \"endDate\": \"20230308\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ROAS\",\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"threshold\": 2.0\n }\n },\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "response": [ { "name": "Update rule state", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 17:14:40 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "154" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7P345KQQCHNDVD1XXGTA" }, { "key": "x-amzn-RequestId", "value": "d79a1d7f-5011-4989-97d7-8d08ea6b9ebb" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "7P345KQQCHNDVD1XXGTA" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 17:14:40 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "154" }, { "key": "x-amz-apigw-id", "value": "ApeT_Gm5IAMFj2w=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3aa80-544ed52fccd1995dd519aa75" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 17:14:39 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": [\n \"102028944323821\"\n ],\n \"code\": \"Ok\",\n \"details\": \"Budget rule updated\",\n \"ruleId\": \"f1eded08-af77-454a-b307-7783802657e2\"\n }\n ]\n}" }, { "name": "Update name, end date, increase value", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"ruleType\": \"PERFORMANCE\",\n \"name\": \"Spring Budget Rule - Updated\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230220\",\n \"endDate\": \"20230308\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ROAS\",\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"threshold\": 2.0\n }\n },\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 18:14:34 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "154" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "EBEDH0821H74K4F2QGMD" }, { "key": "x-amzn-RequestId", "value": "a1049984-0c37-4bf8-a49e-4a7eca0965e3" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "EBEDH0821H74K4F2QGMD" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 18:14:34 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "154" }, { "key": "x-amz-apigw-id", "value": "ApnFjFGqIAMF4Fg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3b88a-26b3c2d8534d987e11cd82bb" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 18:14:33 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": [\n \"102028944323821\"\n ],\n \"code\": \"Ok\",\n \"details\": \"Budget rule updated\",\n \"ruleId\": \"f1eded08-af77-454a-b307-7783802657e2\"\n }\n ]\n}" } ] }, { "name": "Disassociate budget rule from campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" }, { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" }, { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:19:07 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "3" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ANWG7PZ1MTH68RCXNZ3M" }, { "key": "x-amzn-RequestId", "value": "7c1bd3b8-4c25-4596-a752-7729fbded41c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "ANWG7PZ1MTH68RCXNZ3M" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:19:07 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "3" }, { "key": "x-amz-apigw-id", "value": "Aq22yGmGIAMFXWg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f4382b-f178d333423a74ae085c578e" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:19:06 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{}" } ] }, { "name": "Campaigns associated with a rule", "event": [ { "listen": "test", "script": { "exec": [ "/*Save campaignId from first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No campaigns were returned.\");", "} else {", "", " if(responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " var campaignId = response.campaigns[0].campaignId", " postman.clearEnvironmentVariable(\"campaignId\");", " postman.setEnvironmentVariable(\"campaignId\", campaignId); ", " console.log(\"campaignId from first campaign object is \" + campaignId);", " } else {", " console.log(responseBody);", " }", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/budgetRules/:budgetRuleId/campaigns?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules", ":budgetRuleId", "campaigns" ], "query": [ { "key": "pageSize", "value": "30" }, { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/budgetRules/:budgetRuleId/campaigns?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules", ":budgetRuleId", "campaigns" ], "query": [ { "key": "pageSize", "value": "30" }, { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 17:03:30 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "146" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "T5MHPSDX7S14CPTA5G96" }, { "key": "x-amzn-RequestId", "value": "483da119-0f4c-4921-953a-b17a01165517" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "T5MHPSDX7S14CPTA5G96" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 17:03:30 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "146" }, { "key": "x-amz-apigw-id", "value": "ApcrbFlhIAMFzxA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3a7e2-a50c0c143620610a8ce2593c" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 17:03:30 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedCampaigns\": [\n {\n \"campaignId\": \"102028944323821\",\n \"campaignName\": \"Campaign - 2/20/2023 11:52:05\",\n \"ruleStatus\": \"ON_HOLD\"\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Budget rule by ID", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sp/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sp", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 16:59:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "617" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "0EDT072240KNMZ79AZEK" }, { "key": "x-amzn-RequestId", "value": "ece8866d-bad2-4614-b295-9a410c3f6b3d" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "0EDT072240KNMZ79AZEK" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 16:59:39 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "617" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "ApcHTFC-oAMFjww=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3a6fb-924827d85a94557fa7b86ba9" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 16:59:38 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"budgetRule\": {\n \"createdDate\": 1676912194576,\n \"lastUpdatedDate\": 1676912194576,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230228\",\n \"startDate\": \"20230220\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring Budget Rule\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 2\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"f1eded08-af77-454a-b307-7783802657e2\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n}" } ] }, { "name": "Rules associated with a campaign", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sp/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sp", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Mon, 20 Feb 2023 17:00:14 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1333" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "KF72AWK69CGTAKYBFXQR" }, { "key": "x-amzn-RequestId", "value": "61f10a9b-b2a8-403f-9d04-c117771e1b55" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "KF72AWK69CGTAKYBFXQR" }, { "key": "X-Amz-Date", "value": "Mon, 20 Feb 2023 17:00:14 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1333" }, { "key": "x-amz-apigw-id", "value": "ApcM0G5SoAMFQEA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f3a71e-075db1a13cdd6780e6df1615" }, { "key": "x-amzn-Remapped-Date", "value": "Mon, 20 Feb 2023 17:00:13 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedRules\": [\n {\n \"createdDate\": 1676912194576,\n \"lastUpdatedDate\": 1676912194576,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230228\",\n \"startDate\": \"20230220\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring Budget Rule\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 2\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"f1eded08-af77-454a-b307-7783802657e2\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ON_HOLD\",\n \"ruleStatusDetails\": {\n \"reasonCode\": \"INELIGIBLE_PERFORMANCE_METRIC\",\n \"status\": \"ON_HOLD\"\n }\n },\n {\n \"createdDate\": 1676912153402,\n \"lastUpdatedDate\": 1676912153402,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": null,\n \"eventTypeRuleDuration\": {\n \"endDate\": \"20230515\",\n \"eventId\": \"1b943597-d48e-5147-abd1-7ed20fcb693c\",\n \"eventName\": \"Mother's Day\",\n \"startDate\": \"20230511\"\n }\n },\n \"name\": \"Mother's Day Budget Rule\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"c29298a0-0369-4146-8065-a73d33d51779\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": {\n \"reasonCode\": null,\n \"status\": \"PENDING_START\"\n }\n }\n ]\n}" } ] } ] }, { "name": "SD", "item": [ { "name": "Create budget rules", "event": [ { "listen": "test", "script": { "exec": [ "/* Save ruleId to environment */", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var budgetRuleId = response.responses[0].ruleId", "postman.clearEnvironmentVariable(\"budgetRuleId\");", "postman.setEnvironmentVariable(\"budgetRuleId\", budgetRuleId); ", " console.log(\"ruleId is \" + budgetRuleId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"ACOS < 20%\",\n \"ruleType\": \"PERFORMANCE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ACOS\",\n \"threshold\": 20,\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\"\n }\n }\n ]\n}" }, "url": "{{api_url}}/sd/budgetRules" }, "response": [ { "name": "Scheduled, weekly rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"Spring 35%\",\n \"ruleType\": \"SCHEDULE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"WEEKLY\",\n \"daysOfWeek\": [\n \"MONDAY\",\"WEDNESDAY\"\n ]\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 35\n }\n }\n ]\n}" }, "url": "{{api_url}}/sd/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:43:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7M37X86D20F969C1DEDQ" }, { "key": "x-amzn-RequestId", "value": "2530cea3-a169-4ca8-add0-af90c9a4574e" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "7M37X86D20F969C1DEDQ" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:43:42 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq6dUEj8oAMFlOw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43dee-b8efc6b8e020fb2b1d635c8b" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:43:41 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"3b12acec-cba0-45b8-bb10-59a44dc52896\"\n }\n ]\n}" }, { "name": "Performance-based rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"ACOS < 20%\",\n \"ruleType\": \"PERFORMANCE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ACOS\",\n \"threshold\": 20,\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\"\n }\n }\n ]\n}" }, "url": "{{api_url}}/sd/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:46:11 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "E3T9BSDHWX5GV1G2AQ8Z" }, { "key": "x-amzn-RequestId", "value": "a1b2209a-342e-437a-886a-642ddd050582" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "E3T9BSDHWX5GV1G2AQ8Z" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:46:11 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq60iEcaIAMFXtw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43e83-61138e6738d959eda0e09434" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:46:11 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"89f07de4-e24c-4aa0-bffd-7ae916b65b50\"\n }\n ]\n}" } ] }, { "name": "Associate budget rules to campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\n \"{{budgetRuleId}}\"\n ]\n}" }, "url": { "raw": "{{api_url}}/sd/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sd", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\n \"{{budgetRuleId}}\"\n ]\n}" }, "url": { "raw": "{{api_url}}/sd/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sd", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:46:47 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "113" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "12T3ED9DWDF19E155D0G" }, { "key": "x-amzn-RequestId", "value": "765df155-33aa-45b4-a5cd-6f792dcad5b8" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "12T3ED9DWDF19E155D0G" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:46:47 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "113" }, { "key": "x-amz-apigw-id", "value": "Aq66EHJRIAMF5NA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43ea6-a48df5066713a8f0a3ed9c88" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:46:46 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"code\": \"Ok\",\n \"details\": \"Budget rule associated\",\n \"ruleId\": \"89f07de4-e24c-4aa0-bffd-7ae916b65b50\"\n }\n ]\n}" } ] }, { "name": "All budget rules", "event": [ { "listen": "test", "script": { "exec": [ "/*Save budgetRuleId from first object to environment*/", "", "if (responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " if(!response.budgetRulesForAdvertiserResponse[0]) {", " console.info(\"No rules were returned.\");", " } else {", " var budgetRuleId = response.budgetRulesForAdvertiserResponse[0].ruleId", " postman.clearEnvironmentVariable(\"budgetRuleId\");", " postman.setEnvironmentVariable(\"budgetRuleId\", budgetRuleId); ", " console.log(\"budgetRuleId from first rule object is \" + budgetRuleId);", " } ", "} else {", " console.log(responseCode, responseBody);", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sd/budgetRules?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sd", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true }, { "key": "pageSize", "value": "30" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sd/budgetRules?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sd", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true }, { "key": "pageSize", "value": "30" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:47:30 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1191" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "ER4M3S32R1EWY1Y73PN4" }, { "key": "x-amzn-RequestId", "value": "da6d1635-fed6-4414-a85e-e7d66769dd22" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "ER4M3S32R1EWY1Y73PN4" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:47:30 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1191" }, { "key": "x-amz-apigw-id", "value": "Aq7A8HXxoAMF2QQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43ed2-37e98abcfda32ef66540f7fa" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:47:30 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"budgetRulesForAdvertiserResponse\": [\n {\n \"createdDate\": 1676951022655,\n \"lastUpdatedDate\": 1676951022655,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 35\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230430\",\n \"startDate\": \"20230301\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring 35%\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": [\n \"MONDAY\",\n \"WEDNESDAY\"\n ],\n \"intraDaySchedule\": null,\n \"type\": \"WEEKLY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"3b12acec-cba0-45b8-bb10-59a44dc52896\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": null\n },\n {\n \"createdDate\": 1676951171268,\n \"lastUpdatedDate\": 1676951171268,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230430\",\n \"startDate\": \"20230301\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"ACOS < 20%\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ACOS\",\n \"threshold\": 20\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"89f07de4-e24c-4aa0-bffd-7ae916b65b50\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": null\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Update budget rules", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sd/budgetRules" }, "response": [ { "name": "Update name, end date, increase value", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"ruleType\": \"PERFORMANCE\",\n \"name\": \"Spring Budget Rule - Updated\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230220\",\n \"endDate\": \"20230308\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ROAS\",\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"threshold\": 2.0\n }\n },\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n ]\n}" }, "url": "{{api_url}}/sd/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:47:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "A6NBGVWD21W8ZRXSNN6B" }, { "key": "x-amzn-RequestId", "value": "935641ad-ae7b-469f-96c4-dc80b8cbf3b6" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "A6NBGVWD21W8ZRXSNN6B" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:47:51 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "Aq7ERG0IoAMFTKg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43ee7-86bd2bce65646bc03a626a2c" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:47:51 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule updated\",\n \"ruleId\": \"3b12acec-cba0-45b8-bb10-59a44dc52896\"\n }\n ]\n}" }, { "name": "Update rule state", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sd/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:48:47 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "SXHBP2GVV9TDGSQQ6XEN" }, { "key": "x-amzn-RequestId", "value": "591d8261-b909-4e1c-8865-f694e23e25bd" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "SXHBP2GVV9TDGSQQ6XEN" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:48:47 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "Aq7M6EHsIAMFpZw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43f1f-99833e08d38b0f4991b8e3f8" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:48:46 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule updated\",\n \"ruleId\": \"3b12acec-cba0-45b8-bb10-59a44dc52896\"\n }\n ]\n}" } ] }, { "name": "Disassociate budget rule from campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/campaigns/:campaignId/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sd", "campaigns", ":campaignId", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" }, { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/campaigns/:campaignId/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sd", "campaigns", ":campaignId", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" }, { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:49:31 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "3" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "C2RZXC6JTY2VKGPFG3BT" }, { "key": "x-amzn-RequestId", "value": "6fbf17ed-5de1-4911-8d1e-adfc1da5f4f0" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "C2RZXC6JTY2VKGPFG3BT" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:49:31 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "3" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq7TsHEAIAMFd5A=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43f4b-c96b5b89c6cba97a224fd70b" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:49:30 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{}" } ] }, { "name": "Campaigns associated with a rule", "event": [ { "listen": "test", "script": { "exec": [ "/*Save campaignId from first object to environment*/", "var response = JSON.parse(responseBody);", "if(response.totalResults === 0) {", " console.info(\"No campaigns were returned.\");", "} else {", "", " if(responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " var campaignId = response.campaigns[0].campaignId", " postman.clearEnvironmentVariable(\"campaignId\");", " postman.setEnvironmentVariable(\"campaignId\", campaignId); ", " console.log(\"campaignId from first campaign object is \" + campaignId);", " } else {", " console.log(responseBody);", " }", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/budgetRules/:budgetRuleId/campaigns?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sd", "budgetRules", ":budgetRuleId", "campaigns" ], "query": [ { "key": "pageSize", "value": "30" }, { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/budgetRules/:budgetRuleId/campaigns?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sd", "budgetRules", ":budgetRuleId", "campaigns" ], "query": [ { "key": "pageSize", "value": "30" }, { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:50:35 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "145" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "TS1MZ58FM263CZF0TBVP" }, { "key": "x-amzn-RequestId", "value": "cb2c92c8-77f2-4cc1-9d8f-8739cfe2b23a" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "TS1MZ58FM263CZF0TBVP" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:50:35 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "145" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq7d2GkZoAMFTcw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43f8b-a03efb5ff1c0a7696e413866" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:50:35 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedCampaigns\": [\n {\n \"campaignId\": \"144765279800494\",\n \"campaignName\": \"Campaign - 2/20/2023 22:44:56\",\n \"ruleStatus\": \"PAUSED\"\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Budget rule by ID", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sd", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sd/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sd", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:50:15 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "618" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "W73PTBD723G8V10DVV2S" }, { "key": "x-amzn-RequestId", "value": "1065ef44-6ed5-44b9-92f3-5cabf41543b1" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "W73PTBD723G8V10DVV2S" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:50:15 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "618" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq7asHu-IAMF07A=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43f77-e8566d44f74ce72ed7fbc913" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:50:15 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"budgetRule\": {\n \"createdDate\": 1676951022655,\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230308\",\n \"startDate\": \"20230220\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring Budget Rule - Updated\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 2\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"3b12acec-cba0-45b8-bb10-59a44dc52896\",\n \"ruleState\": \"PAUSED\",\n \"ruleStatus\": \"PAUSED\",\n \"ruleStatusDetails\": null\n }\n}" } ] }, { "name": "Rules associated with a campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sd/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sd", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sd/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sd", "campaigns", ":campaignId", "budgetRules" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:51:13 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1297" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "6KJ3TTHS70FQAWZBF4BV" }, { "key": "x-amzn-RequestId", "value": "c493f119-967b-4b08-ba8c-f18320d2e315" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "6KJ3TTHS70FQAWZBF4BV" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:51:13 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1297" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq7jtGG7IAMFx6Q=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43fb1-0026c341e31684e72aa44b0f" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:51:12 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedRules\": [\n {\n \"createdDate\": 1676951022655,\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230308\",\n \"startDate\": \"20230220\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring Budget Rule - Updated\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 2\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"3b12acec-cba0-45b8-bb10-59a44dc52896\",\n \"ruleState\": \"PAUSED\",\n \"ruleStatus\": \"PAUSED\",\n \"ruleStatusDetails\": {\n \"reasonCode\": null,\n \"status\": \"PAUSED\"\n }\n },\n {\n \"createdDate\": 1676951171268,\n \"lastUpdatedDate\": 1676951171268,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230430\",\n \"startDate\": \"20230301\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"ACOS < 20%\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ACOS\",\n \"threshold\": 20\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"89f07de4-e24c-4aa0-bffd-7ae916b65b50\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": {\n \"reasonCode\": null,\n \"status\": \"PENDING_START\"\n }\n }\n ]\n}" } ] } ] }, { "name": "SB", "item": [ { "name": "Create budget rules", "event": [ { "listen": "test", "script": { "exec": [ "/* Save ruleId to environment */", "if(responseCode.code === 207) {", "var response = JSON.parse(responseBody);", "var budgetRuleId = response.responses[0].ruleId", "postman.clearEnvironmentVariable(\"budgetRuleId\");", "postman.setEnvironmentVariable(\"budgetRuleId\", budgetRuleId); ", " console.log(\"ruleId is \" + budgetRuleId);", "} else {", " console.log(responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"Easter 25%\",\n \"ruleType\": \"SCHEDULE\",\n \"duration\": {\n \"eventTypeRuleDuration\": {\n \"eventId\": \"{{eventId}}\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n }\n }\n ]\n}" }, "url": "{{api_url}}/sb/budgetRules" }, "response": [ { "name": "Scheduled, weekly rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"Spring 35%\",\n \"ruleType\": \"SCHEDULE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"WEEKLY\",\n \"daysOfWeek\": [\n \"MONDAY\",\"WEDNESDAY\"\n ]\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 35\n }\n }\n ]\n}" }, "url": "{{api_url}}/sb/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:22:01 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "GRW6AP7WX24X1G4J0VCK" }, { "key": "x-amzn-RequestId", "value": "f999385d-becd-4f8e-8b7c-a709d43799b1" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "GRW6AP7WX24X1G4J0VCK" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:22:01 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq3SDHRcoAMF4sQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f438d9-9f750bfb62be9426997acbff" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:22:00 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"7788e003-ff0b-4005-bcfb-b68936103a9d\"\n }\n ]\n}" }, { "name": "Performance-based rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"ACOS < 20%\",\n \"ruleType\": \"PERFORMANCE\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230301\",\n \"endDate\": \"20230430\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ROAS\",\n \"threshold\": 20,\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\"\n }\n }\n ]\n}" }, "url": "{{api_url}}/sb/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:23:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "M9WF55D6MJ3JE89ZBY35" }, { "key": "x-amzn-RequestId", "value": "862016f5-fbab-4063-895d-af1db3fc995b" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "M9WF55D6MJ3JE89ZBY35" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:23:51 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "Aq3jQFURIAMFjjw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43947-ccb94a1f7407520189b6b535" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:23:51 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"19b62c40-0f4a-4995-adfb-a921808e7788\"\n }\n ]\n}" }, { "name": "Event-based, scheduled, daily rule", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"name\": \"Easter 25%\",\n \"ruleType\": \"SCHEDULE\",\n \"duration\": {\n \"eventTypeRuleDuration\": {\n \"eventId\": \"899f0ac0-987c-00b8-146a-bf380f43b671\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 25\n }\n }\n ]\n}" }, "url": "{{api_url}}/sb/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:39:35 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CHN76G9CMSBK2HD7P581" }, { "key": "x-amzn-RequestId", "value": "2d3b43b6-4ebd-4436-8b18-5cfca7278cda" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "CHN76G9CMSBK2HD7P581" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:39:35 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "Aq52uGTFIAMFtLA=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43cf7-499176fb960fe3de498d48b3" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:39:34 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule created\",\n \"ruleId\": \"52323b15-3202-46f4-a04b-e90f8940508f\"\n }\n ]\n}" } ] }, { "name": "Associate budget rules to campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\n \"{{budgetRuleId}}\"\n ]\n}" }, "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRuleIds\": [\n \"7788e003-ff0b-4005-bcfb-b68936103a9d\"\n ]\n}" }, "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:33:04 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "113" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "X2HQN3R55624FY7FKKJQ" }, { "key": "x-amzn-RequestId", "value": "c4be822a-d373-4873-ae7d-ca1154ee3afd" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "X2HQN3R55624FY7FKKJQ" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:33:04 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "113" }, { "key": "x-amz-apigw-id", "value": "Aq45kEQBIAMFfHw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43b70-21f3ef406a2e4ae14a1b8b82" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:33:04 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"code\": \"Ok\",\n \"details\": \"Budget rule associated\",\n \"ruleId\": \"7788e003-ff0b-4005-bcfb-b68936103a9d\"\n }\n ]\n}" } ] }, { "name": "Get recommended events", "event": [ { "listen": "test", "script": { "exec": [ "", "/*Save eventId from first object to environment*/", "", "if (responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " if(!response.recommendedBudgetRuleEvents[0]) {", " console.info(\"No events were returned.\");", " } else {", " var eventId = response.recommendedBudgetRuleEvents[0].eventId", " postman.clearEnvironmentVariable(\"eventId\");", " postman.setEnvironmentVariable(\"eventId\", eventId); ", " console.log(\"eventId from first event object is \" + eventId);", " } ", "} else {", " console.log(responseCode, responseBody);", "}", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbbudgetrulesrecommendation.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignId\":\"{{campaignId}}\"\n}" }, "url": "{{api_url}}/sb/campaigns/budgetRules/recommendations" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbbudgetrulesrecommendation.v3+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignId\":\"{{campaignId}}\"\n}" }, "url": "{{api_url}}/sb/campaigns/budgetRules/recommendations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:30:09 GMT" }, { "key": "Content-Type", "value": "application/vnd.sbbudgetrulesrecommendation.v3+json" }, { "key": "Content-Length", "value": "1777" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "5HF1MYZQ4K3N1JFV3E34" }, { "key": "x-amz-request-id", "value": "5HF1MYZQ4K3N1JFV3E34" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"recommendedBudgetRuleEvents\": [\n {\n \"endDate\": \"20230409\",\n \"eventId\": \"899f0ac0-987c-00b8-146a-bf380f43b671\",\n \"eventName\": \"Easter\",\n \"startDate\": \"20230406\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20230514\",\n \"eventId\": \"aceadb70-d48d-36b2-504c-bedfe6a064e6\",\n \"eventName\": \"Mother's day\",\n \"startDate\": \"20230511\",\n \"suggestedBudgetIncreasePercent\": 43\n },\n {\n \"endDate\": \"20230529\",\n \"eventId\": \"efd3f243-7a10-1177-7857-7bf52fa0bb23\",\n \"eventName\": \"Memorial Day\",\n \"startDate\": \"20230526\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20230618\",\n \"eventId\": \"3ce6b731-7b87-c728-ee52-aae04ab3620b\",\n \"eventName\": \"Father's Day\",\n \"startDate\": \"20230615\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20230704\",\n \"eventId\": \"58879a0b-82a6-412b-0a75-96ffea7ec847\",\n \"eventName\": \"Independence Day\",\n \"startDate\": \"20230701\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20230904\",\n \"eventId\": \"0bdd5eed-0eba-1a8d-2cdf-d77599d63f39\",\n \"eventName\": \"Labor Day\",\n \"startDate\": \"20230901\",\n \"suggestedBudgetIncreasePercent\": 32\n },\n {\n \"endDate\": \"20231031\",\n \"eventId\": \"dc891b6d-84ff-339c-fd42-f89f63f47e7f\",\n \"eventName\": \"Halloween\",\n \"startDate\": \"20231028\",\n \"suggestedBudgetIncreasePercent\": 25\n },\n {\n \"endDate\": \"20231124\",\n \"eventId\": \"4a4cb57f-9ea8-53e3-10c3-ad1de4966d05\",\n \"eventName\": \"Black Friday\",\n \"startDate\": \"20231121\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20231127\",\n \"eventId\": \"5ff2257a-d12f-dc30-43ee-0df7e1b63290\",\n \"eventName\": \"Cyber Monday\",\n \"startDate\": \"20231124\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20231225\",\n \"eventId\": \"781c59b1-557e-10bf-6b79-10f4adab5b37\",\n \"eventName\": \"Christmas\",\n \"startDate\": \"20231222\",\n \"suggestedBudgetIncreasePercent\": null\n },\n {\n \"endDate\": \"20231231\",\n \"eventId\": \"da5293f7-f70d-664b-c87a-13f1b7cfd663\",\n \"eventName\": \"New Years Eve\",\n \"startDate\": \"20231228\",\n \"suggestedBudgetIncreasePercent\": null\n }\n ]\n}" } ] }, { "name": "All budget rules", "event": [ { "listen": "test", "script": { "exec": [ "/*Save budgetRuleId from first object to environment*/", "", "if (responseCode.code === 200) {", " var response = JSON.parse(responseBody);", " if(!response.budgetRulesForAdvertiserResponse[0]) {", " console.info(\"No rules were returned.\");", " } else {", " var budgetRuleId = response.budgetRulesForAdvertiserResponse[0].ruleId", " postman.clearEnvironmentVariable(\"budgetRuleId\");", " postman.setEnvironmentVariable(\"budgetRuleId\", budgetRuleId); ", " console.log(\"budgetRuleId from first rule object is \" + budgetRuleId);", " } ", "} else {", " console.log(responseCode, responseBody);", "}" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sb/budgetRules?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sb", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true }, { "key": "pageSize", "value": "30" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sb/budgetRules?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sb", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true }, { "key": "pageSize", "value": "30" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:33:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1191" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JYY4C1JRK2GJ7R69KA9N" }, { "key": "x-amzn-RequestId", "value": "9bdd3093-e114-4dba-8fd5-f554472262f2" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "JYY4C1JRK2GJ7R69KA9N" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:33:39 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "1191" }, { "key": "x-amz-apigw-id", "value": "Aq4_FEkUoAMF6tg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43b93-f4eaa80bb3f50fbc7ab442cf" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:33:39 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"budgetRulesForAdvertiserResponse\": [\n {\n \"createdDate\": 1676949831857,\n \"lastUpdatedDate\": 1676949831857,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 20\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230430\",\n \"startDate\": \"20230301\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"ACOS < 20%\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"LESS_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 20\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"19b62c40-0f4a-4995-adfb-a921808e7788\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": null\n },\n {\n \"createdDate\": 1676949721783,\n \"lastUpdatedDate\": 1676949721783,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 35\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230430\",\n \"startDate\": \"20230301\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring 35%\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": [\n \"MONDAY\",\n \"WEDNESDAY\"\n ],\n \"intraDaySchedule\": null,\n \"type\": \"WEEKLY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"7788e003-ff0b-4005-bcfb-b68936103a9d\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": null\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Update budget rules", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"ruleType\": \"PERFORMANCE\",\n \"name\": \"Spring Budget Rule - Updated\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230220\",\n \"endDate\": \"20230308\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ROAS\",\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"threshold\": 2.0\n }\n },\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n ]\n}" }, "url": "{{api_url}}/sp/budgetRules" }, "response": [ { "name": "Update budget rule state", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"PAUSED\"\n }\n ]\n}" }, "url": "{{api_url}}/sb/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:34:13 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "8K4HF8R5CZ63TJGD9XGH" }, { "key": "x-amzn-RequestId", "value": "13a1855b-2f0d-44f0-a3ef-9f76dad90788" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "8K4HF8R5CZ63TJGD9XGH" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:34:13 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "Aq5EXEJ9oAMFpSg=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43bb5-b4fab5835f0b8b7a6d3ee464" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:34:13 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule updated\",\n \"ruleId\": \"19b62c40-0f4a-4995-adfb-a921808e7788\"\n }\n ]\n}" }, { "name": "Update name, end date, increase value", "originalRequest": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"budgetRulesDetails\": [\n {\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"ruleType\": \"PERFORMANCE\",\n \"name\": \"Spring Budget Rule - Updated\",\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"startDate\": \"20230220\",\n \"endDate\": \"20230308\"\n }\n },\n \"recurrence\": {\n \"type\": \"DAILY\"\n },\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"performanceMeasureCondition\": {\n \"metricName\": \"ROAS\",\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"threshold\": 2.0\n }\n },\n \"ruleId\": \"{{budgetRuleId}}\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n ]\n}" }, "url": "{{api_url}}/sb/budgetRules" }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:34:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "139" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "39906RCGEJWB19ECME8F" }, { "key": "x-amzn-RequestId", "value": "3244ad2f-9828-4196-8b44-95998aaf3c42" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "39906RCGEJWB19ECME8F" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:34:41 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "139" }, { "key": "x-amz-apigw-id", "value": "Aq5IzFQIIAMFwTw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43bd1-892eb2fca796ee363b3ac777" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:34:41 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"responses\": [\n {\n \"associatedCampaignIds\": null,\n \"code\": \"Ok\",\n \"details\": \"Budget rule updated\",\n \"ruleId\": \"19b62c40-0f4a-4995-adfb-a921808e7788\"\n }\n ]\n}" } ] }, { "name": "Disassociate budget rule from campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" }, { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" }, { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:40:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "3" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "V415VF5CACFFCM3M886M" }, { "key": "x-amzn-RequestId", "value": "21970933-eebe-44c8-8b42-13cab6ea2264" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "V415VF5CACFFCM3M886M" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:40:42 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "3" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq6BHHveoAMFQWw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43d3a-09fbed25080f80728cb6d89a" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:40:41 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{}" } ] }, { "name": "Campaigns associated with a rule", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sb/budgetRules/:budgetRuleId/campaigns?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sb", "budgetRules", ":budgetRuleId", "campaigns" ], "query": [ { "key": "pageSize", "value": "30" }, { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Campaigns associated with a rule", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sb/budgetRules/:budgetRuleId/campaigns?pageSize=30", "host": [ "{{api_url}}" ], "path": [ "sb", "budgetRules", ":budgetRuleId", "campaigns" ], "query": [ { "key": "pageSize", "value": "30" }, { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:41:04 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "151" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "5Z73H1FE77HQ47B2SYKV" }, { "key": "x-amzn-RequestId", "value": "ac271a72-3a20-4fda-a82a-5ed3196ca6e0" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "5Z73H1FE77HQ47B2SYKV" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:41:04 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "151" }, { "key": "x-amz-apigw-id", "value": "Aq6EnGM9IAMFkSQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43d50-f9fb4311a045ed81c20d25d4" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:41:04 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedCampaigns\": [\n {\n \"campaignId\": \"38789817437281\",\n \"campaignName\": \"Campaign - 2/20/2023 22:26:18\",\n \"ruleStatus\": \"PENDING_START\"\n }\n ],\n \"nextToken\": null\n}" } ] }, { "name": "Budget rule by ID", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sb/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sb", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" } ], "url": { "raw": "{{api_url}}/sb/budgetRules/:budgetRuleId", "host": [ "{{api_url}}" ], "path": [ "sb", "budgetRules", ":budgetRuleId" ], "variable": [ { "key": "budgetRuleId", "value": "{{budgetRuleId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:35:44 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "618" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "MQ3YKQ4EZ1Q2VEF6NGKX" }, { "key": "x-amzn-RequestId", "value": "20156d64-ae45-467c-b683-27a7933c0a5c" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "MQ3YKQ4EZ1Q2VEF6NGKX" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:35:44 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "618" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "Aq5SmG2zIAMFg1Q=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43c10-3c298fba32c77b36ec2b8198" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:35:44 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"budgetRule\": {\n \"createdDate\": 1676949831857,\n \"lastUpdatedDate\": null,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 75\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230308\",\n \"startDate\": \"20230220\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring Budget Rule - Updated\",\n \"performanceMeasureCondition\": {\n \"comparisonOperator\": \"GREATER_THAN_OR_EQUAL_TO\",\n \"metricName\": \"ROAS\",\n \"threshold\": 2\n },\n \"recurrence\": {\n \"daysOfWeek\": null,\n \"intraDaySchedule\": null,\n \"type\": \"DAILY\"\n },\n \"ruleType\": \"PERFORMANCE\"\n },\n \"ruleId\": \"19b62c40-0f4a-4995-adfb-a921808e7788\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"ACTIVE\",\n \"ruleStatusDetails\": null\n }\n}" } ] }, { "name": "Rules associated with a campaign", "event": [ { "listen": "test", "script": { "exec": [ "", "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/sb/campaigns/:campaignId/budgetRules", "host": [ "{{api_url}}" ], "path": [ "sb", "campaigns", ":campaignId", "budgetRules" ], "query": [ { "key": "nextToken", "value": null, "disabled": true } ], "variable": [ { "key": "campaignId", "value": "{{campaignId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 21 Feb 2023 03:36:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "598" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "E9GR3VCG9XZ417XVABTD" }, { "key": "x-amzn-RequestId", "value": "3cc8567b-c7a7-4525-be03-058e573c66ad" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "E9GR3VCG9XZ417XVABTD" }, { "key": "X-Amz-Date", "value": "Tue, 21 Feb 2023 03:36:32 GMT" }, { "key": "x-amzn-Remapped-Content-Length", "value": "598" }, { "key": "x-amz-apigw-id", "value": "Aq5aBGs0IAMF2iQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63f43c40-1ffb48b6ce994ffd25d26419" }, { "key": "x-amzn-Remapped-Date", "value": "Tue, 21 Feb 2023 03:36:31 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"associatedRules\": [\n {\n \"createdDate\": 1676949721783,\n \"lastUpdatedDate\": 1676949721783,\n \"ruleDetails\": {\n \"budgetIncreaseBy\": {\n \"type\": \"PERCENT\",\n \"value\": 35\n },\n \"duration\": {\n \"dateRangeTypeRuleDuration\": {\n \"endDate\": \"20230430\",\n \"startDate\": \"20230301\"\n },\n \"eventTypeRuleDuration\": null\n },\n \"name\": \"Spring 35%\",\n \"performanceMeasureCondition\": null,\n \"recurrence\": {\n \"daysOfWeek\": [\n \"MONDAY\",\n \"WEDNESDAY\"\n ],\n \"intraDaySchedule\": null,\n \"type\": \"WEEKLY\"\n },\n \"ruleType\": \"SCHEDULE\"\n },\n \"ruleId\": \"7788e003-ff0b-4005-bcfb-b68936103a9d\",\n \"ruleState\": \"ACTIVE\",\n \"ruleStatus\": \"PENDING_START\",\n \"ruleStatusDetails\": {\n \"reasonCode\": null,\n \"status\": \"PENDING_START\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "Budget usage", "item": [ { "name": "Sponsored Products", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spcampaignbudgetusage.v1+json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}" }, "url": "{{api_url}}/sp/campaigns/budget/usage" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spcampaignbudgetusage.v1+json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}" }, "url": "{{api_url}}/sp/campaigns/budget/usage" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 28 Mar 2023 19:10:23 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "153" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "N39AEDBWGWRZ02SEVN7S" }, { "key": "x-amzn-RequestId", "value": "7edf0cae-072f-4487-9e14-1b15ae406bb5" }, { "key": "x-amz-apigw-id", "value": "CgZA-HyfoAMFp5A=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64233b9f-73e46bf27b04db0cc44ff2ce" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"error\": [],\n \"success\": [\n {\n \"budget\": 10,\n \"budgetUsagePercent\": 0,\n \"campaignId\": \"102028944323821\",\n \"index\": 0,\n \"usageUpdatedTimestamp\": \"2023-03-28T07:00:00Z\"\n }\n ]\n}" } ] }, { "name": "Sponsored Brands", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.spcampaignbudgetusage.v1+json", "type": "default" }, { "key": "", "value": "", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}" }, "url": "{{api_url}}/sp/campaigns/budget/usage" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}" }, "url": "{{api_url}}/sb/campaigns/budget/usage" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 28 Mar 2023 19:02:09 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "152" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "X7DGV4H0E2SPHF308X74" }, { "key": "x-amzn-RequestId", "value": "3fe6674b-2a88-4350-810c-e825585d5b7d" }, { "key": "x-amz-apigw-id", "value": "CgXzsFUbIAMFlQQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-642339b1-bd48a4a96ea5c3737c48e5c5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"error\": [],\n \"success\": [\n {\n \"budget\": 50,\n \"budgetUsagePercent\": 0,\n \"campaignId\": \"38789817437281\",\n \"index\": 0,\n \"usageUpdatedTimestamp\": \"2023-03-28T07:07:48Z\"\n }\n ]\n}" } ] }, { "name": "Sponsored Display", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}" }, "url": "{{api_url}}/sd/campaigns/budget/usage" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIds\": [\n \"{{campaignId}}\"\n ]\n}" }, "url": "{{api_url}}/sd/campaigns/budget/usage" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 28 Mar 2023 19:03:47 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "154" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "889RREHY1E5S0PP7JXXQ" }, { "key": "x-amzn-RequestId", "value": "6b5456eb-75fb-4941-9181-756e309c39bb" }, { "key": "x-amz-apigw-id", "value": "CgYDAHAkIAMF1Hg=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64233a13-564dfa07c55752d77c58e064" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"error\": [],\n \"success\": [\n {\n \"budget\": 100,\n \"budgetUsagePercent\": 0,\n \"campaignId\": \"144765279800494\",\n \"index\": 0,\n \"usageUpdatedTimestamp\": \"2023-03-28T07:12:17Z\"\n }\n ]\n}" } ] } ] }, { "name": "Creative asset library", "item": [ { "name": "Create URL", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save mediaId to environment*/", "var response = JSON.parse(responseBody);", "var url = response.url", "postman.clearEnvironmentVariable(\"url\");", "postman.setEnvironmentVariable(\"url\", url);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"filename\": \"myfile.mov\"\n}\n" }, "url": "{{api_url}}/assets/upload" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"filename\": \"hd0992.mov\"\n}\n" }, "url": "{{api_url}}/assets/upload" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 17 Jan 2023 21:18:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "849" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "T4F0C9H6K2RJKPQH6J7E" }, { "key": "x-amzn-RequestId", "value": "d652e8db-b263-458c-8547-a7446eb77b28" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token" }, { "key": "x-amz-apigw-id", "value": "e5-NNG_gIAMF-eA=" }, { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS,POST" }, { "key": "Access-Control-Expose-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,customerid,entityid" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63c710bb-3d1f5986526dd990c4d7f3d8" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"url\": \"https://al-na-184b9306-7f8a.s3.amazonaws.com/5080709a-5705-41d4-9fdf-3d97c1bcb4fb.mov?x-amz-meta-filename=hd0992.mov&X-Amz-Security-Token=FwoGZXIvYXdzEPf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDP33mYcnuRRWxlTjKyLIAaWFgKnWmAg8QWKQ%2BSM9LjiloYkTT8nEjrnIkG2%2BLjGZA4XIaHCZSipJ4GtEuRUqyM4VZnRfytXxS9fQoj9iU2xHPGFD%2F%2Ff5SIYmIhst%2BnNfJgvFoOK8yFUS8jswdPoEzlEL9LGXHieLTuB7etjce6VJP7TPY90PhylUeyakY5LSjAbCaBMlewHLnVmkOGf%2F%2FA6AOTboDgZeDkozq11iB0IZHS0NZJ7IkgXOD3TjdKDaohajSy1VDxr2Fn%2FHamGgm%2F09bCyPyLvNKKCfnJ4GMi26bZIm5R%2BI83frnm%2B8A1QX5ICFmA5904S93h%2BkDMwEbgvYQkSvE64rIlVazpY%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230117T211851Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAQSMWEWJEJPSR5EG5%2F20230117%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=55669130242c9a09bfbfd3f9403d529ef11769359faf5f8d94cd5688e47acf90\"\n}" } ] }, { "name": "Upload file", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [], "body": { "mode": "file", "file": { "src": "" } }, "url": "{{url}}" }, "response": [] }, { "name": "Register asset", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save mediaId to environment*/", "var response = JSON.parse(responseBody);", "var mediaId = response.mediaId", "postman.clearEnvironmentVariable(\"mediaId\");", "postman.setEnvironmentVariable(\"mediaId\", mediaId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"{{uploadUrl}}\",\n \"name\": \"myVideoAsset2\",\n \"asinList\": [\n \"B07R7V6KS8\",\n \"B07X2X4D5H\",\n \"B003L1717K\"\n ],\n \"assetType\": \"VIDEO\",\n \"assetSubTypeList\": [\n \"BACKGROUND_VIDEO\"\n ],\n \"associatedSubEntityList\": [\n {\n \"brandEntityId\": \"{{brandEntityId}}\"\n }\n ]\n}\n\n" }, "url": "{{api_url}}/assets/register" }, "response": [ { "name": "SB video asset", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"{{url}}\",\n \"name\": \"myVideoAsset3\",\n \"asinList\": [\n \"B07R7V6KS8\",\n \"B07X2X4D5H\",\n \"B003L1717K\"\n ],\n \"assetType\": \"VIDEO\",\n \"assetSubTypeList\": [\n \"BACKGROUND_VIDEO\"\n ],\n \"associatedSubEntityList\": [\n {\n \"brandEntityId\": \"{{brandEntityId}}\"\n }\n ]\n}\n\n" }, "url": "{{api_url}}/assets/register" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 17 Jan 2023 21:25:42 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1488" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "4RX68FW0Y0S947KFTVJH" }, { "key": "x-amzn-RequestId", "value": "816e1e65-2231-4d07-8c0a-707a9f84ec08" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token" }, { "key": "x-amz-apigw-id", "value": "e5_MlHB1IAMF6sQ=" }, { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS,POST" }, { "key": "Access-Control-Expose-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,customerid,entityid" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63c71256-90ef6ddb70c746e22b2366c4" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"assetId\": \"amzn1.assetlibrary.asset1.b3a6cc6c0cd418beb0d1fa2bb9f9d632\",\n \"failedSpecChecks\": [\n {\n \"Program\": \"AMAZON_DSP\",\n \"specProgramName\": \"DEMAND_SIDE_PLATFORM_OLV\",\n \"specifications\": [\n {\n \"actualValue\": \"30.0\",\n \"arguments\": [\n \"23.98\",\n \"24.0\",\n \"25.0\",\n \"29.97\"\n ],\n \"failureReason\": \"Frame rate is not one of 23.98, 24.0, 25.0, 29.97.\",\n \"isPassed\": false,\n \"stringId\": \"al-spec-video-frame-rate\"\n },\n {\n \"actualValue\": \"0\",\n \"arguments\": [\n \"2\"\n ],\n \"failureReason\": \"Total number of audio channels across all audio streams is less than 2.\",\n \"isPassed\": false,\n \"stringId\": \"al-spec-min-audio-channel-count\"\n }\n ]\n },\n {\n \"Program\": \"AMAZON_DSP\",\n \"specProgramName\": \"DEMAND_SIDE_PLATFORM_OTT\",\n \"specifications\": [\n {\n \"actualValue\": \"30.0\",\n \"arguments\": [\n \"23.98\",\n \"24.0\",\n \"25.0\",\n \"29.97\"\n ],\n \"failureReason\": \"Frame rate is not one of 23.98, 24.0, 25.0, 29.97.\",\n \"isPassed\": false,\n \"stringId\": \"al-spec-video-frame-rate\"\n },\n {\n \"actualValue\": \"9.966667\",\n \"arguments\": [\n \"15.0\",\n \"30.0\"\n ],\n \"failureReason\": \"Duration is not one of 15.0, 30.0 seconds.\",\n \"isPassed\": false,\n \"stringId\": \"al-spec-video-duration\"\n },\n {\n \"actualValue\": \"0\",\n \"arguments\": [\n \"2\"\n ],\n \"failureReason\": \"Total number of audio channels across all audio streams is less than 2.\",\n \"isPassed\": false,\n \"stringId\": \"al-spec-min-audio-channel-count\"\n }\n ]\n },\n {\n \"Program\": \"STORES\",\n \"specProgramName\": \"STORES_INTRO_SPLASH\",\n \"specifications\": [\n {\n \"actualValue\": \"16:9\",\n \"arguments\": [\n \"9:16\"\n ],\n \"failureReason\": \"Aspect ratio is not 9:16.\",\n \"isPassed\": false,\n \"stringId\": \"al-spec-video-aspect-ratio\"\n }\n ]\n }\n ],\n \"programPolicyValidationsList\": null,\n \"versionId\": \"version_v1\"\n}" }, { "name": "SB custom image", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"{{url}}\",\n \"name\": \"myCustomImage\",\n \"asinList\": [\n \"B07XXXXX8\",\n \"B07XXXXXH\",\n \"B0XXXXXXK\"\n ],\n \"assetType\": \"IMAGE\",\n \"assetSubTypeList\": [\n \"LOGO\"\n ],\n \"associatedSubEntityList\": [\n {\n \"brandEntityId\": \"{{brandEntityId}}\"\n }\n ]\n}\n\n" }, "url": "{{api_url}}/assets/register" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 18 Jan 2023 16:07:50 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "155" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "XTDRJHA8EV5375348865" }, { "key": "x-amzn-RequestId", "value": "a0b33dfd-725e-4a94-a787-9c187bac55bc" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token" }, { "key": "x-amz-apigw-id", "value": "e8jjmEutoAMFpNA=" }, { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS,POST" }, { "key": "Access-Control-Expose-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,customerid,entityid" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-63c81956-1769272d93fe79de2e6bd507" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"assetId\": \"amzn1.assetlibrary.asset1.de8262bd1e344573be2e713b5832b920\",\n \"failedSpecChecks\": [],\n \"programPolicyValidationsList\": null,\n \"versionId\": \"version_v1\"\n}" } ] }, { "name": "Assets", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save mediaId to environment*/", "var response = JSON.parse(responseBody);", "var url = response.url", "postman.clearEnvironmentVariable(\"url\");", "postman.setEnvironmentVariable(\"url\", url);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/assets?assetId={{assetId}}", "host": [ "{{api_url}}" ], "path": [ "assets" ], "query": [ { "key": "assetId", "value": "{{assetId}}" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "url": { "raw": "{{api_url}}/assets?assetId=amzn1.assetlibrary.asset1.XXXXXXX", "host": [ "{{api_url}}" ], "path": [ "assets" ], "query": [ { "key": "assetId", "value": "amzn1.assetlibrary.asset1.XXXXXXX" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 14 Mar 2023 16:53:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "2313" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "JYAX4118B31CBCJQD1W3" }, { "key": "x-amzn-RequestId", "value": "0cf536f6-089f-4605-a226-7f6b8fc6db81" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token" }, { "key": "x-amz-apigw-id", "value": "Bx76JF3FoAMFmsg=" }, { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS,POST" }, { "key": "Access-Control-Expose-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,customerid,entityid" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6410a6a7-b87cb2dd9cdec10189d90191" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"assetGlobal\": {\n \"accountIds\": [\n \"ADVERTISER:ENTITYXXXXXXX\"\n ],\n \"assetId\": \"amzn1.assetlibrary.asset1.XXXXXXX\",\n \"assetType\": \"IMAGE\",\n \"marketplaceId\": [\n \"ATVPDKIKX0DER\"\n ]\n },\n \"assetVersionList\": [\n {\n \"assetFiles\": {\n \"defaultUrl\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\",\n \"processedFiles\": [\n {\n \"fileMetadata\": null,\n \"imageCroppingData\": null,\n \"profile\": \"IMAGE_THUMBNAIL_500\",\n \"programs\": [],\n \"url\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63._SL500_.png\"\n },\n {\n \"fileMetadata\": null,\n \"imageCroppingData\": null,\n \"profile\": \"MODERATION\",\n \"programs\": [],\n \"url\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\"\n }\n ],\n \"relatedFiles\": []\n },\n \"assetIdentifier\": {\n \"assetId\": \"amzn1.assetlibrary.asset1.244a164b7e592cf42b125cbdd0ee7712\",\n \"version\": \"version_v1\"\n },\n \"assetStatus\": \"ACTIVE\",\n \"assetSubTypes\": [\n \"LOGO\"\n ],\n \"createdBy\": \"A8WE7O8XSB7G4\",\n \"creationTime\": 1676950071460,\n \"failedSpecChecks\": [],\n \"fileMetadata\": {\n \"aspectRatio\": \"1:1\",\n \"audioSampleRateInHz\": 0,\n \"contentHash\": null,\n \"contentType\": \"image/png\",\n \"durationInSeconds\": 0,\n \"extension\": \"PNG\",\n \"height\": 400,\n \"resolutionHeight\": 0,\n \"resolutionWidth\": 0,\n \"sizeInBytes\": 1307,\n \"width\": 400\n },\n \"focalPoint\": null,\n \"lastUpdatedBy\": \"A8WE7O8XSB7G4\",\n \"lastUpdatedTime\": 1678466679857,\n \"moderationContentList\": [\n {\n \"adPolicyModerationResultList\": [\n {\n \"locale\": \"en_US\",\n \"marketplaceId\": \"ATVPDKIKX0DER\",\n \"moderationStatus\": \"APPROVED\",\n \"policyName\": \"HSA4V_PRODUCTS\",\n \"rejectionReasonList\": [],\n \"rejectionReasons\": null\n }\n ],\n \"assetSubType\": \"LOGO\",\n \"moderationContentStatus\": \"COMPLETED\"\n }\n ],\n \"moderationRequestStatus\": \"SKIPPED\",\n \"name\": \"400.png\",\n \"otherMetadata\": {},\n \"programPolicyValidationsList\": null,\n \"specCheckApprovedPrograms\": null,\n \"stockInformation\": null,\n \"storageLocationUrls\": {\n \"defaultUrl\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\",\n \"processedUrls\": {\n \"IMAGE_THUMBNAIL_500\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63._SL500_.png\",\n \"MODERATION\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\"\n },\n \"relatedUrls\": {}\n },\n \"url\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\",\n \"versionNotes\": null\n }\n ]\n}" } ] }, { "name": "Assets search", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"response should not be an error\", function () {", " pm.response.to.not.be.error;", "});", "", "/*Save mediaId to environment*/", "var response = JSON.parse(responseBody);", "var url = response.url", "postman.clearEnvironmentVariable(\"url\");", "postman.setEnvironmentVariable(\"url\", url);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{{\n \"filterCriteria\": {\n \"valueFilters\": [\n {\n \"values\": [\n \"IMAGE\"\n ],\n \"valueField\": \"ASSET_TYPE\"\n }\n ],\n \"rangeFilters\": [\n {\n \"rangeField\": \"SIZE\"\n \"range\": [\n {\n \"start\": \"1\",\n \"end\": \"100\"\n }\n ]\n }\n ]\n },\n \"sortCriteria\": {\n \"field\": \"CREATED_TIME\",\n \"order\": \"ASC\"\n },\n}}" }, "url": "{{api_url}}/assets/search" }, "response": [ { "name": "All assets", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.sbadresource.v4+json", "type": "default", "disabled": true } ], "body": { "mode": "raw", "raw": "{}" }, "url": "{{api_url}}/assets/search" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 14 Mar 2023 16:53:33 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "10761" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "CQT6MS8FATNVAJ0F0A74" }, { "key": "x-amzn-RequestId", "value": "c0ef56be-15ad-467b-8531-07c00a90c26c" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token" }, { "key": "x-amz-apigw-id", "value": "Bx72JEAcIAMFQJQ=" }, { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS,POST" }, { "key": "Access-Control-Expose-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,customerid,entityid" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6410a68d-cb2dbb08a4bb0644ad95b881" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"assetList\": [\n {\n \"assetId\": \"amzn1.assetlibrary.asset1.244a164b7e592cf42b125cbdd0ee7712\",\n \"assetSubTypeList\": [\n \"LOGO\"\n ],\n \"assetType\": \"IMAGE\",\n \"associatedAccountIds\": [\n \"ADVERTISER:ENTITYXXXXXXX\"\n ],\n \"associatedContexts\": {\n \"ASIN\": [\n {\n \"id\": \"B07XXXXXX\",\n \"name\": null\n },\n {\n \"id\": \"B07XXXXXX\",\n \"name\": null\n },\n {\n \"id\": \"B00XXXXXX\",\n \"name\": null\n }\n ],\n \"HSA\": [\n {\n \"id\": \"38789817437281\",\n \"name\": \"Campaign - 2/20/2023 22:26:18\"\n }\n ],\n \"PROGRAM\": [\n {\n \"id\": \"HSA\",\n \"name\": null\n },\n {\n \"id\": \"SB\",\n \"name\": null\n }\n ]\n },\n \"collections\": [],\n \"createdBy\": \"A8WE7O8XSB7G4\",\n \"creationTime\": 1676950071460,\n \"fileMetadata\": {\n \"aspectRatio\": \"1:1\",\n \"audioSampleRateInHz\": 0,\n \"contentHash\": null,\n \"contentType\": \"image/png\",\n \"durationInSeconds\": 0,\n \"extension\": \"PNG\",\n \"height\": 400,\n \"resolutionHeight\": 0,\n \"resolutionWidth\": 0,\n \"sizeInBytes\": 1307,\n \"width\": 400\n },\n \"focalPoint\": null,\n \"lastUpdatedBy\": \"AdvertisingAssetContextEventsLambda\",\n \"lastUpdatedTime\": 1678466679794,\n \"marketplaces\": [\n \"ATVPDKIKX0DER\"\n ],\n \"moderationPolicyMap\": {\n \"Logo\": \"REJECTED\"\n },\n \"moderationRequestStatus\": \"SKIPPED\",\n \"name\": \"400.png\",\n \"specCheckApprovedPrograms\": null,\n \"status\": \"ACTIVE\",\n \"stockInformation\": null,\n \"storageLocationUrls\": {\n \"defaultUrl\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\",\n \"processedUrls\": {\n \"IMAGE_THUMBNAIL_500\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63._SL500_.png\",\n \"MODERATION\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\"\n },\n \"relatedUrls\": null\n },\n \"tags\": [],\n \"version\": \"version_v1\"\n },\n {\n \"assetId\": \"amzn1.assetlibrary.asset1.b961e17bb562aba838c0816adf3fe16c\",\n \"assetSubTypeList\": [],\n \"assetType\": \"VIDEO\",\n \"associatedAccountIds\": [\n \"ADVERTISER:ENTITY1XXXXXX\"\n ],\n \"associatedContexts\": {\n \"PROGRAM\": [\n {\n \"id\": \"SB\",\n \"name\": null\n }\n ]\n },\n \"collections\": [],\n \"createdBy\": \"A8WE7O8XSB7G4\",\n \"creationTime\": 1678295739836,\n \"fileMetadata\": {\n \"aspectRatio\": null,\n \"audioSampleRateInHz\": 0,\n \"contentHash\": null,\n \"contentType\": \"video/quicktime\",\n \"durationInSeconds\": 9,\n \"extension\": \"mov\",\n \"height\": 0,\n \"resolutionHeight\": 1080,\n \"resolutionWidth\": 1920,\n \"sizeInBytes\": 44243886,\n \"width\": 0\n },\n \"focalPoint\": null,\n \"lastUpdatedBy\": \"A8WE7O8XSB7G4\",\n \"lastUpdatedTime\": 1678311675207,\n \"marketplaces\": [\n \"ATVPDKIKX0DER\"\n ],\n \"moderationPolicyMap\": {},\n \"moderationRequestStatus\": \"SKIPPED\",\n \"name\": \"hd0992.mov\",\n \"specCheckApprovedPrograms\": [\n \"SPONSORED_BRANDS_VIDEO\",\n \"STORES_VIDEO_TILE\",\n \"STORES_BACKGROUND_VIDEO_TILE\",\n \"SPONSORED_DISPLAY_VIDEO\"\n ],\n \"status\": \"ACTIVE\",\n \"stockInformation\": null,\n \"storageLocationUrls\": {\n \"defaultUrl\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov\",\n \"processedUrls\": {\n \"BACKGROUND_VIDEO_TILE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/backgroundVideoTile.mp4\",\n \"INTRO_SPLASH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/introSplash.mp4\",\n \"MODERATION\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/moderation\",\n \"MP4_10000KBS_30FPS_48KHZ_320KBS_1080P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_10000kbs_30fps_48khz_320Kbs_1080p.mp4\",\n \"MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_10000Kbs_30fps_48khz_320Kbs_1080p_H264_high.mp4\",\n \"MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_1350Kbs_25fps_48khz_128Kbs_540p_H264_main.mp4\",\n \"MP4_1350KBS_30FPS_48KHZ_96KBS_720P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_1350kbs_30fps_48khz_96Kbs_720p.mp4\",\n \"MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_1350Kbs_30fps_48khz_96Kbs_720p_H264_high.mp4\",\n \"MP4_1500KBS_24FPS_48KHZ_96KBS_576P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_1500Kbs_24fps_48khz_96Kbs_576p.mp4\",\n \"MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_1500Kbs_25fps_48khz_128Kbs_576p_H264_high.mp4\",\n \"MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_1500Kbs_30fps_48khz_192Kbs_540p_H264_high.mp4\",\n \"MP4_20000KBS_AUTOFPS_48KHZ_320KBS\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_20000kbs_autofps_48khz_320Kbs.mp4\",\n \"MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_20000Kbs_autofps_48khz_320Kbs_1080p_H264_high.mp4\",\n \"MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_2000Kbs_30fps_48khz_192Kbs_720p_H264_high.mp4\",\n \"MP4_2000KBS_30FPS_48KHZ_96KBS_720P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_2000kbs_30fps_48khz_96Kbs_720p.mp4\",\n \"MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_2000Kbs_30fps_48khz_96Kbs_720p_H264_high.mp4\",\n \"MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_2100Kbs_30fps_48khz_192Kbs_480p_H264_main.mp4\",\n \"MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_2100Kbs_30fps_48khz_192Kbs_576p_H264_high.mp4\",\n \"MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_25000Kbs_30fps_48khz_192Kbs_1080p_H264_high.mp4\",\n \"MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_25000Kbs_30fps_48khz_192Kbs_1080p_H264_main.mp4\",\n \"MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_260Kbs_25fps_48khz_64Kbs_180p_H264_baseline.mp4\",\n \"MP4_300KBS_15FPS_48KHZ_96KBS_360P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_300Kbs_15fps_48khz_96Kbs_360p.mp4\",\n \"MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_300Kbs_30fps_48khz_96Kbs_360p_H264_baseline.mp4\",\n \"MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_320Kbs_25fps_48khz_96Kbs_576p_H264_high.mp4\",\n \"MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_3400Kbs_30fps_48khz_192Kbs_1080p_H264_high.mp4\",\n \"MP4_3500KBS_24FPS_48KHZ_96KBS_1080P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_3500Kbs_24fps_48khz_96Kbs_1080p.mp4\",\n \"MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_3500Kbs_30fps_48khz_128Kbs_720p_H264_high.mp4\",\n \"MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_375Kbs_30fps_48khz_192Kbs_360p_H264_high.mp4\",\n \"MP4_4000KBS_30FPS_48KHZ_192KBS_1080P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_4000kbs_30fps_48khz_192Kbs_1080p.mp4\",\n \"MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_4000Kbs_30fps_48khz_192Kbs_1080p_H264_high.mp4\",\n \"MP4_450KBS_15FPS_48KHZ_96KBS_360P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_450Kbs_15fps_48khz_96Kbs_360p.mp4\",\n \"MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_450Kbs_30fps_48khz_96Kbs_360p_H264_baseline.mp4\",\n \"MP4_600KBS_15FPS_48KHZ_96KBS_480P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_600Kbs_15fps_48khz_96Kbs_480p.mp4\",\n \"MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_600Kbs_25fps_48khz_128Kbs_360p_H264_baseline.mp4\",\n \"MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_600Kbs_30fps_48khz_128Kbs_360p_H264_baseline.mp4\",\n \"MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_600Kbs_30fps_48khz_96Kbs_480p_H264_baseline.mp4\",\n \"MP4_700KBS_24FPS_48KHZ_96KBS_360P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_700Kbs_24fps_48khz_96Kbs_360p.mp4\",\n \"MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_750Kbs_25fps_48khz_96Kbs_576p_H264_high.mp4\",\n \"MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_750Kbs_30fps_48khz_192Kbs_432p_H264_high.mp4\",\n \"MP4_900KBS_15FPS_48KHZ_96KBS_480P\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_900Kbs_15fps_48khz_96Kbs_480p.mp4\",\n \"MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/mp4_900Kbs_30fps_48khz_96Kbs_480p_H264_baseline.mp4\",\n \"PRODUCT_VIDEO_OPTIMIZED\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/productVideoOptimized.mp4\",\n \"VIDEO_DEFAULT_OPTIMIZED\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/videoDefaultOptimized\",\n \"VIDEO_TILE\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/0de54885-4fa0-47a6-b0f5-b4dba2549817.mov/videoTile.mp4\"\n },\n \"relatedUrls\": null\n },\n \"tags\": [],\n \"version\": \"version_v1\"\n }\n ],\n \"token\": null,\n \"totalRecords\": 2\n}" }, { "name": "With filters", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"filterCriteria\": {\n \"valueFilters\": [\n {\n \"values\": [\n \"IMAGE\"\n ],\n \"valueField\": \"ASSET_TYPE\"\n }\n ],\n \"rangeFilters\": [\n {\n \"ranges\": [\n {\n \"start\": \"1\",\n \"end\": \"5000\"\n }\n ],\n \"rangeField\": \"SIZE\"\n }\n ]\n },\n \"sortCriteria\": {\n \"field\": \"CREATED_TIME\",\n \"order\": \"ASC\"\n }\n}" }, "url": "{{api_url}}/assets/search" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 14 Mar 2023 17:06:02 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1547" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "AZ5363ZACATKEEM6KSQF" }, { "key": "x-amzn-RequestId", "value": "814891a8-f0d3-4c8e-8074-869c02d831ae" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token" }, { "key": "x-amz-apigw-id", "value": "Bx9rFHOOoAMF6ug=" }, { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS,POST" }, { "key": "Access-Control-Expose-Headers", "value": "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,customerid,entityid" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6410a97a-ae91b8120abfad4e0de20737" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"assetList\": [\n {\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxxx\",\n \"assetSubTypeList\": [\n \"LOGO\"\n ],\n \"assetType\": \"IMAGE\",\n \"associatedAccountIds\": [\n \"ADVERTISER:ENTITYXXXXXXXX\"\n ],\n \"associatedContexts\": {\n \"ASIN\": [\n {\n \"id\": \"B07X2X4D5H\",\n \"name\": null\n },\n {\n \"id\": \"B07R7V6KS8\",\n \"name\": null\n },\n {\n \"id\": \"B003L1717K\",\n \"name\": null\n }\n ],\n \"HSA\": [\n {\n \"id\": \"XXXXXXXXX\",\n \"name\": \"Campaign - 2/20/2023 22:26:18\"\n }\n ],\n \"PROGRAM\": [\n {\n \"id\": \"HSA\",\n \"name\": null\n },\n {\n \"id\": \"SB\",\n \"name\": null\n }\n ]\n },\n \"collections\": [],\n \"createdBy\": \"A8WE7O8XSB7G4\",\n \"creationTime\": 1676950071460,\n \"fileMetadata\": {\n \"aspectRatio\": \"1:1\",\n \"audioSampleRateInHz\": 0,\n \"contentHash\": null,\n \"contentType\": \"image/png\",\n \"durationInSeconds\": 0,\n \"extension\": \"PNG\",\n \"height\": 400,\n \"resolutionHeight\": 0,\n \"resolutionWidth\": 0,\n \"sizeInBytes\": 1307,\n \"width\": 400\n },\n \"focalPoint\": null,\n \"lastUpdatedBy\": \"AdvertisingAssetContextEventsLambda\",\n \"lastUpdatedTime\": 1678466679794,\n \"marketplaces\": [\n \"ATVPDKIKX0DER\"\n ],\n \"moderationPolicyMap\": {\n \"Logo\": \"REJECTED\"\n },\n \"moderationRequestStatus\": \"SKIPPED\",\n \"name\": \"400.png\",\n \"specCheckApprovedPrograms\": null,\n \"status\": \"ACTIVE\",\n \"stockInformation\": null,\n \"storageLocationUrls\": {\n \"defaultUrl\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\",\n \"processedUrls\": {\n \"IMAGE_THUMBNAIL_500\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63._SL500_.png\",\n \"MODERATION\": \"https://m.media-amazon.com/images/S/al-na-9d5791cf-3faf/731a5378-8437-4b79-ac24-67102260ca63.png\"\n },\n \"relatedUrls\": null\n },\n \"tags\": [],\n \"version\": \"version_v1\"\n }\n ],\n \"token\": null,\n \"totalRecords\": 1\n}" } ] } ] }, { "name": "Locations", "item": [ { "name": "Browse locations", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"name\",\n \"values\": [\n \"New Yor\"\n ]\n },\n {\n \"field\": \"category\",\n \"values\": [\n \"STATE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/locations/list", "description": "brandEntityID is required for sellers" }, "response": [ { "name": "State filter", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"name\",\n \"values\": [\n \"New Yor\"\n ]\n },\n {\n \"field\": \"category\",\n \"values\": [\n \"STATE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/locations/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 20 Jul 2023 15:21:49 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "101" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "SDJSEYVT2QZJNE4SWT6W" }, { "key": "x-amzn-RequestId", "value": "e8ddd8df-2d7d-4b65-af42-87c16925d9dd" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "SDJSEYVT2QZJNE4SWT6W" }, { "key": "x-amzn-Remapped-Content-Length", "value": "101" }, { "key": "x-amzn-Remapped-Connection", "value": "close" }, { "key": "x-amz-apigw-id", "value": "IXmZ8EnIoAMFXFw=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64b9510d-f962190fdabfb75db656949d" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 20 Jul 2023 15:21:49 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"locations\": [\n {\n \"category\": \"STATE\",\n \"locationId\": \"amzn1.ad-geo.G23XLKJV9KV95N\",\n \"name\": \"New York, US\"\n }\n ]\n}" }, { "name": "ZIP code filter", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"name\",\n \"values\": [\n \"9800\"\n ]\n },\n {\n \"field\": \"category\",\n \"values\": [\n \"POSTAL_CODE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/locations/list" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Thu, 20 Jul 2023 15:22:33 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "995" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "TSVSVE9N5RHZV4S3Y9BY" }, { "key": "x-amzn-RequestId", "value": "64246c2f-e647-4a6a-b3b1-0f0c88f867be" }, { "key": "x-amzn-Remapped-x-amzn-RequestId", "value": "TSVSVE9N5RHZV4S3Y9BY" }, { "key": "x-amzn-Remapped-Content-Length", "value": "995" }, { "key": "x-amz-apigw-id", "value": "IXmg_HVwoAMFXkQ=" }, { "key": "x-amzn-Remapped-Server", "value": "Apache-Coyote/1.1" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-64b95139-1b293824678a66c3b8ff3489" }, { "key": "x-amzn-Remapped-Date", "value": "Thu, 20 Jul 2023 15:22:33 GMT" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"locations\": [\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98001\",\n \"name\": \"Auburn, Washington, US - 98001\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98002\",\n \"name\": \"Auburn, Washington, US - 98002\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98003\",\n \"name\": \"Federal Way, Washington, US - 98003\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98004\",\n \"name\": \"Bellevue, Washington, US - 98004\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98005\",\n \"name\": \"Bellevue, Washington, US - 98005\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98006\",\n \"name\": \"Bellevue, Washington, US - 98006\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98007\",\n \"name\": \"Bellevue, Washington, US - 98007\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98008\",\n \"name\": \"Bellevue, Washington, US - 98008\"\n },\n {\n \"category\": \"POSTAL_CODE\",\n \"locationId\": \"amzn1.ad-geo.GP-US-98009\",\n \"name\": \"Bellevue, Washington, US - 98009\"\n }\n ]\n}" } ] } ] }, { "name": "Exports", "item": [ { "name": "Request campaign export", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned exportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"exportId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"exportId\", response.exportId);", " console.log('exportId = ' + pm.environment.get(\"exportId\"));", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.campaignsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.campaignsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/campaigns/export" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.campaignsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.campaignsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/campaigns/export" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 26 Sep 2023 15:32:02 GMT" }, { "key": "Content-Type", "value": "application/vnd.campaignsexport.v1+json" }, { "key": "Content-Length", "value": "89" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "3ZN9V830HZC5TAPJZVY1" }, { "key": "x-amzn-RequestId", "value": "0a2f2859-b12d-4854-af7f-9954c31991f7" }, { "key": "x-amz-apigw-id", "value": "L3vp3FE3oAMFdlQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6512f972-1a8df3331e7670ae5f82e0a5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"xxxxxxxxxxxxx\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "Request ad group export", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned exportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"exportId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"exportId\", response.exportId);", " console.log('exportId = ' + pm.environment.get(\"exportId\"));", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.adgroupsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.adgroupsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/adGroups/export" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.adgroupsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.adgroupsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/adGroups/export" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 26 Sep 2023 15:33:04 GMT" }, { "key": "Content-Type", "value": "application/vnd.adgroupsexport.v1+json" }, { "key": "Content-Length", "value": "89" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "6GJJMR04JZBZYWZFVADP" }, { "key": "x-amzn-RequestId", "value": "b088dfb2-1e45-4901-a569-23a578c29bf1" }, { "key": "x-amz-apigw-id", "value": "L3vzeE-DIAMFleQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6512f9b0-6978f3cc86dbc5033f63e1e5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"xxxxxxxxxxx\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "Request target export", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned exportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"exportId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"exportId\", response.exportId);", " console.log('exportId = ' + pm.environment.get(\"exportId\"));", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.targetsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/targets/export" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.targetsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/targets/export" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 26 Dec 2023 16:55:29 GMT" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json" }, { "key": "Content-Length", "value": "89" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "2NCX66Q7GDTB7PRZEZQY" }, { "key": "x-amzn-RequestId", "value": "59a7d341-15f8-4022-a302-c36cd9d9e13d" }, { "key": "x-amz-apigw-id", "value": "Qj3MOF0pIAMF0Cw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-658b0581-8c5e59d55f3637777c850f48" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"ZTc1ZmM1ODYtM2Y5Ny00N2QwLTlhY2UtNTdmMTQzOWI2YTIxLFQ\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "Request ad export", "event": [ { "listen": "test", "script": { "exec": [ "/**Sets the returned exportId as an environment variable to be used in subsequent calls */", "postman.clearEnvironmentVariable(\"exportId\");", "var response = JSON.parse(responseBody);", "", "if (response && response.status === 'IN_PROGRESS') {", " postman.setEnvironmentVariable(\"exportId\", response.exportId);", " console.log('exportId = ' + pm.environment.get(\"exportId\"));", "}", "else {", " console.log('Error creating campaign with error = ' + response.description);", "}" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.targetsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/targets/export" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.adsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.adsexport.v1+json", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adProductFilter\": [\n \"SPONSORED_BRANDS\",\"SPONSORED_PRODUCTS\", \"SPONSORED_DISPLAY\"\n ]\n}" }, "url": "{{api_url}}/ads/export" }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 14 Feb 2024 17:10:08 GMT" }, { "key": "Content-Type", "value": "application/vnd.adsexport.v1+json" }, { "key": "Content-Length", "value": "89" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "R555YQAT9Q7BA1PJXWT0" }, { "key": "x-amzn-RequestId", "value": "a6b0e711-7ee2-4a59-b570-57f083254313" }, { "key": "x-amz-apigw-id", "value": "TIsNhE7MIAMFlIw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-65ccf3f0-5109ac8d2c60682952dfc886" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"NDUxYTIyMzgtZTFjMi00MDcxLTlhOTMtZDMxYjRkMzFhNzY2LFI\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "Exports status", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.targetsexport.v1+json", "type": "default" } ], "url": "{{api_url}}/exports/{{exportId}}" }, "response": [ { "name": "Campaigns export", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.campaignsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.campaignsexport.v1+json", "type": "default" } ], "url": "{{api_url}}/exports/{{exportId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 26 Sep 2023 15:38:44 GMT" }, { "key": "Content-Type", "value": "application/vnd.campaignsexport.v1+json" }, { "key": "Content-Length", "value": "1601" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "2RTMY94WX1VW155XSHBQ" }, { "key": "x-amzn-RequestId", "value": "e1c96053-a1be-48e9-84ed-3fd9f9fdc4c5" }, { "key": "x-amz-apigw-id", "value": "L3wowEvBoAMFneQ=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6512fb04-c9eea8e6cffb20e8b8f349d5" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"OTZlODY4NTQtN2ZhZi00YWQwLWFmMDEtYjU4NDE0YzUwYWFhLEM\",\n \"status\": \"COMPLETED\",\n \"url\": \"https://snapshots-prod-us-east-1.s3.us-east-1.amazonaws.com/CAMPAIGN/amzn1.application-oa2-client.xxxxxxxxxxxxxxxxx\",\n \"fileSize\": 782,\n \"urlExpiresAt\": \"2023-09-26T16:38:44.604Z\",\n \"generatedAt\": \"2023-09-26T15:38:16.609Z\",\n \"createdAt\": \"2023-09-26T15:38:15.938Z\"\n}" }, { "name": "Ad groups export", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.adgroupsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.adgroupsexport.v1+json", "type": "default" } ], "url": "{{api_url}}/exports/{{exportId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Tue, 26 Sep 2023 15:39:24 GMT" }, { "key": "Content-Type", "value": "application/vnd.adgroupsexport.v1+json" }, { "key": "Content-Length", "value": "1601" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "7DYKBGGQJPJ6JSFVYJ98" }, { "key": "x-amzn-RequestId", "value": "6907ca70-9f8d-48d2-869e-f807958da769" }, { "key": "x-amz-apigw-id", "value": "L3wvAHcmoAMFYvw=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-6512fb2c-9df8b09ba63f1968bd741e48" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"MjJmNWZiZmYtY2NlZC00MzFhLWI5NjAtMmE3MjQzMGFiMDIwLEE\",\n \"status\": \"COMPLETED\",\n \"url\": \"https://snapshots-prod-us-east-1.s3.us-east-1.amazonaws.com/AD_GROUP/amzn1.application-oa2-client.xxxxxxxxxxxxxx\",\n \"fileSize\": 515,\n \"urlExpiresAt\": \"2023-09-26T16:39:24.673Z\",\n \"generatedAt\": \"2023-09-26T15:39:09.958Z\",\n \"createdAt\": \"2023-09-26T15:39:09.336Z\"\n}" }, { "name": "Targets export", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.targetsexport.v1+json", "type": "default" } ], "url": "{{api_url}}/exports/{{exportId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 14 Feb 2024 17:11:26 GMT" }, { "key": "Content-Type", "value": "application/vnd.targetsexport.v1+json" }, { "key": "Content-Length", "value": "1624" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "Q3NGD0Y892ZB553H7WWY" }, { "key": "x-amzn-RequestId", "value": "c7821c55-0e90-42e8-8778-05144ae7e7c9" }, { "key": "x-amz-apigw-id", "value": "TIsZ1EmcoAMFa2A=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-65ccf43e-9a69dac2102de4241b78bde8" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"NDA4Y2M5MDItY2I5My00MzRlLWFjMWYtMDg2NGMzYjFhYzNhLFQ\",\n \"status\": \"COMPLETED\",\n \"url\": \"https://snapshots-prod-us-east-1.s3.us-east-1.amazonaws.com/TARGET/amzn1.application-oa2-client.xxxxxxxxxx\",\n \"fileSize\": 3301,\n \"urlExpiresAt\": \"2024-02-14T18:11:26.804Z\",\n \"generatedAt\": \"2024-02-14T17:11:13.590Z\",\n \"createdAt\": \"2024-02-14T17:11:12.845Z\"\n}" }, { "name": "Ads export", "originalRequest": { "method": "GET", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "default" }, { "key": "Content-Type", "value": "application/vnd.adsexport.v1+json", "type": "default" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "default" }, { "key": "Accept", "value": "application/vnd.adsexport.v1+json", "type": "default" } ], "url": "{{api_url}}/exports/{{exportId}}" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "Server" }, { "key": "Date", "value": "Wed, 14 Feb 2024 17:10:36 GMT" }, { "key": "Content-Type", "value": "application/vnd.adsexport.v1+json" }, { "key": "Content-Length", "value": "1629" }, { "key": "Connection", "value": "keep-alive" }, { "key": "x-amz-rid", "value": "45QQABTVYDFBHAHE240S" }, { "key": "x-amzn-RequestId", "value": "295fec12-b54c-447d-8415-b04b64f991b8" }, { "key": "x-amz-apigw-id", "value": "TIsR6F0WoAMFXIA=" }, { "key": "X-Amzn-Trace-Id", "value": "Root=1-65ccf40c-299c7e5ae311f3feaf87c7ef" }, { "key": "Vary", "value": "Content-Type,Accept-Encoding,User-Agent" }, { "key": "Strict-Transport-Security", "value": "max-age=47474747; includeSubDomains; preload" } ], "cookie": [], "body": "{\n \"exportId\": \"NDUxYTIyMzgtZTFjMi00MDcxLTlhOTMtZDMxYjRkMzFhNzY2LFI\",\n \"status\": \"COMPLETED\",\n \"url\": \"https://snapshots-prod-us-east-1.s3.us-east-1.amazonaws.com/PRODUCT_AD/amzn1.application-oa2-client.xxxxxxxxxxx\",\n \"fileSize\": 927,\n \"urlExpiresAt\": \"2024-02-14T18:10:36.212Z\",\n \"generatedAt\": \"2024-02-14T17:10:09.040Z\",\n \"createdAt\": \"2024-02-14T17:10:08.288Z\"\n}" } ] } ] }, { "name": "Sponsored TV", "item": [ { "name": "Campaign", "item": [ { "name": "Create Campaign", "event": [ { "listen": "test", "script": { "exec": [ "var campaignId;", "pm.test(\"Status test\", function () {", " pm.response.to.have.status(207);", " var jsonData = JSON.parse(responseBody);", " campaignId = jsonData.campaigns.success[0].campaignId;", " pm.environment.set(\"e.campaign.id\", campaignId);", " console.log(\"Campaign Id: \" + campaignId);", " ", "});" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true, "accept": true, "accept-encoding": true, "connection": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Amazon-Advertising-API-AdvertiserId", "value": "ENTITY3367XBOE970EG", "type": "text", "disabled": true }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" }, { "key": "Prefer", "value": "return=representation", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [{\n \"budgetSettings\": {\n \"budget\": {\n \"recurrenceType\": \"DAILY\",\n \"budgetValue\": {\n \"amount\": 10.00\n }\n }\n },\n \"startDate\": \"2024-09-25T00:00:00Z\",\n \"endDate\": \"2024-09-25T00:00:00Z\",\n \"name\": \"campaign name\",\n \"state\": \"ENABLED\",\n \"tags\": {\n \"tag1\": \"value1\",\n \"tag2\": \"value2\",\n \"tag3\": \"value3\"\n }\n }]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/campaigns" }, "response": [] }, { "name": "List Campaign", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" }, { "key": "Prefer", "value": "include=extendedData", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"310305299990960\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/campaigns/list" }, "response": [] }, { "name": "Delete Campaign", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"campaignIdFilter\": {\n \"include\": [\n \"543670711287337\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/campaigns/delete" }, "response": [] }, { "name": "Update Campaign", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true, "accept": true, "accept-encoding": true, "connection": true, "content-type": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"campaigns\": [\n {\n \"campaignId\": \"310305299990960\",\n \"state\": \"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/campaigns" }, "response": [] } ] }, { "name": "AdGroup", "item": [ { "name": "Create AdGroup", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status test\", function () {", " pm.response.to.have.status(207);", " var jsonData = JSON.parse(responseBody);", " pm.environment.set(\"e.ad.group.id\", jsonData.adGroups.success[0].adGroupId);", " console.log(\"AdGroupId: \" + jsonData.adGroups.success[0].adGroupId);", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"campaignId\": \"{{campaignId}}\",\n \"name\": \"Ad group name\",\n \"state\": \"ENABLED\",\n \"defaultBid\": {\n \"bid\": 25.0\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/adGroups" }, "response": [] }, { "name": "List AdGroup", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" }, { "key": "Prefer", "value": "include=extendedData", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "default" } ], "body": { "mode": "raw", "raw": "{\n \"adGroupIdFilter\": {\n \"include\": [\n \"362364343252919\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/adGroups/list" }, "response": [] }, { "name": "Update AdGroup", "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"adGroups\": [\n {\n \"adGroupId\": \"527484903577467\",\n \"state\":\"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/adGroups" }, "response": [] }, { "name": "Delete AdGroup", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"adGroupIdFilter\": {\n \"include\": [\n \"426258550878555\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/adGroups/delete" }, "response": [] } ] }, { "name": "Ad", "item": [ { "name": "Create Ad", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "accept-encoding": true, "connection": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" }, { "key": "Prefer", "value": "return=representation", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"adGroupId\": \"{{adGroupId}}\",\n \"state\": \"ENABLED\",\n \"landingPageType\": \"ASIN_DP\",\n \"landingPageValue\": \"B000K2NW08\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/ads" }, "response": [] }, { "name": "List Ad", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true, "accept": true, "accept-encoding": true, "connection": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" }, { "key": "Prefer", "value": "include=extendedData", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"adIdFilter\": {\n \"include\": [\n \"395270913469474\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/ads/list" }, "response": [] }, { "name": "Delete Ad", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true, "accept": true, "accept-encoding": true, "connection": true, "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"adIdFilter\": {\n \"include\": [\n \"292617398029974\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/ads/delete" }, "response": [] }, { "name": "Update Ad", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "accept-encoding": true, "connection": true } }, "request": { "method": "PUT", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" }, { "key": "Prefer", "value": "return=representation", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ads\": [\n {\n \"adId\": \"292617398029974\",\n \"landingPageType\": \"ASIN_DP\",\n \"landingPageValue\": \"B09XZR7GC1\",\n \"state\": \"PAUSED\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/ads" }, "response": [] } ] }, { "name": "Creatives", "item": [ { "name": "Create Creatives", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creatives\": [\n {\n \"assetVersion\": \"version_v1\",\n \"adGroupId\": \"{{adGroupId}}\",\n \"assetId\": \"amzn1.assetlibrary.asset1.xxxxxx\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/creatives" }, "response": [] }, { "name": "List Creatives", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creativeIdFilter\": {\n \"include\": [\n \"870187168950667895\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/creatives/list" }, "response": [] }, { "name": "List Creatives Moderation", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creativeIdFilter\": {\n \"include\": [\n \"870187168950667895\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/creatives/moderations/list" }, "response": [] }, { "name": "List Creatives Moderations Policy Violations", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creativeIdFilter\": {\n \"include\": [\n \"870187168950667895\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/creatives/moderations/policyViolations/list" }, "response": [] }, { "name": "Preview Creatives", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" }, { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "{{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creativeId\": \"869860752003455077\",\n \"previewConfiguration\": {\n \"callToAction\": \"SHOP_NOW\",\n \"asin\": \"B001PYUTII\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{api_url}}/st/creatives/preview" }, "response": [] } ] } ] }, { "name": "Amazon DSP", "item": [ { "name": "Persona builder", "item": [ { "name": "Banded sizes", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"audienceTargetingExpression\": {\n \"audiences\": [\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"419322688608733468\"\n },\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"376383813034626712\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/insights/bandedSize?advertiserId=1111111111", "host": [ "{{api_url}}" ], "path": [ "insights", "bandedSize" ], "query": [ { "key": "advertiserId", "value": "1111111111" } ] } }, "response": [] }, { "name": "Demographics", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"audienceTargetingExpression\": {\n \"audiences\": [\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"419322688608733468\"\n },\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"376383813034626712\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/insights/demographics?advertiserId=11111111", "host": [ "{{api_url}}" ], "path": [ "insights", "demographics" ], "query": [ { "key": "advertiserId", "value": "11111111" } ] } }, "response": [] }, { "name": "Prime Video", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"categoryFilter\": [\"DIRECTORS\"],\n \"audienceTargetingExpression\": {\n \"audiences\": [\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"419322688608733468\"\n },\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"376383813034626712\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/insights/primeVideo?advertiserId=111111111", "host": [ "{{api_url}}" ], "path": [ "insights", "primeVideo" ], "query": [ { "key": "advertiserId", "value": "111111111" } ] } }, "response": [] }, { "name": "Top categories purchased", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"categoryFilter\": [\"INTEREST\"],\n \"audienceTargetingExpression\": {\n \"audiences\": [\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"419322688608733468\"\n },\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"376383813034626712\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/insights/topCategoriesPurchased?advertiserId=11111111", "host": [ "{{api_url}}" ], "path": [ "insights", "topCategoriesPurchased" ], "query": [ { "key": "advertiserId", "value": "11111111" } ] } }, "response": [] }, { "name": "Top overlapping audiences", "request": { "method": "POST", "header": [ { "key": "Amazon-Advertising-API-ClientId", "value": "{{client_id}}", "type": "text" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "default" }, { "key": "Content-Type", "value": "application/json", "type": "default" }, { "key": "Amazon-Advertising-API-Scope", "value": "{{profileId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"categoryFilter\": [\"INTEREST\"],\n \"audienceTargetingExpression\": {\n \"audiences\": [\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"419322688608733468\"\n },\n {\n \"negative\": \"false\",\n \"groupId\": \"Group 1\",\n \"audienceId\": \"376383813034626712\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/insights/topOverlappingAudiences?advertiserId=1111111", "host": [ "{{api_url}}" ], "path": [ "insights", "topOverlappingAudiences" ], "query": [ { "key": "advertiserId", "value": "1111111" } ] } }, "response": [] } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// This pre-request script handles access token freshness for requests in this collection (exception: explicit requests located in the Auth folder). ", "// See the collection documentation for initial setup instructions. ", "// For information about authorization in the Amazon Ads API, visit https://advertising.amazon.com/API/docs/en-us/concepts/authorization/overview", "", "// Ignore script for explicit auth requests", "if (pm.info.requestName.startsWith(\"Access token\") || pm.info.requestName.startsWith(\"Auth grant\")) {", " return false", "}", "", "// Check presence of refresh token", "if (pm.environment.get('refresh_token')) {", "", " // Check expiry of current access token", " if (Date.now() > pm.environment.get('token_expires_at')) {", "", " // Construct refresh token request", " // Information: https://advertising.amazon.com/API/docs/en-us/concepts/authorization/access-tokens#generating-an-access-token-using-a-refresh-token", " const refreshRequest = {", " url: pm.environment.get('token_url'),", " method: \"POST\",", " header: {", " \"Content-Type\": \"application/x-www-form-urlencoded\"", " },", " body: {", " mode: \"urlencoded\",", " urlencoded: [", " 'grant_type=refresh_token',", " `client_id=${pm.environment.get('client_id')}`,", " `refresh_token=${pm.environment.get('refresh_token')}`,", " `client_secret=${pm.environment.get('client_secret')}`", " ]", " }", " }", "", " pm.sendRequest(refreshRequest, (error, response) => {", " if (error) {", " console.log(error)", " } else {", " if (response.code === 200){", " const res = response.json();", " const newExpiry = Date.now() + (res.expires_in * 1000) - 10000", " console.log('Access token retrieved.')", " console.log(`Expires at: ${new Date(newExpiry)}`)", "", " // set access_token, refresh_token, and token_expires_at in Postman environment", " postman.setEnvironmentVariable(\"access_token\", res.access_token);", " postman.setEnvironmentVariable(\"refresh_token\", res.refresh_token);", " postman.setEnvironmentVariable(\"token_expires_at\", newExpiry)", " } else {", " console.log(\"Authorization failed.\")", " console.log(response)", " }", " }", " })", " }", "} else {", " console.log(\"No refresh token found in environment. See documentation for information on auth setup.\")", "}", "", "/**Add custom header containing the collection version to all collection requests*/", "pm.request.headers.add({key: 'Postman-Collection', value: 'Amazon-Ads-API-v1.6'}) " ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }